TCPDF Klassenreferenz

Klassendiagramm für TCPDF:

Öffentliche Methoden

 __construct ($orientation='P', $unit='mm', $format='A4', $unicode=true, $encoding='UTF-8', $diskcache=false, $pdfa=false)
 
 __destruct ()
 
 setPageUnit ($unit)
 
 setPageOrientation ($orientation, $autopagebreak='', $bottommargin='')
 
 setSpacesRE ($re='/[^\S\xa0]/')
 
 setRTL ($enable, $resetx=true)
 
 getRTL ()
 
 setTempRTL ($mode)
 
 isRTLTextDir ()
 
 setLastH ($h)
 
 getCellHeight ($fontsize, $padding=TRUE)
 
 resetLastH ()
 
 getLastH ()
 
 setImageScale ($scale)
 
 getImageScale ()
 
 getPageDimensions ($pagenum='')
 
 getPageWidth ($pagenum='')
 
 getPageHeight ($pagenum='')
 
 getBreakMargin ($pagenum='')
 
 getScaleFactor ()
 
 SetMargins ($left, $top, $right=-1, $keepmargins=false)
 
 SetLeftMargin ($margin)
 
 SetTopMargin ($margin)
 
 SetRightMargin ($margin)
 
 SetCellPadding ($pad)
 
 setCellPaddings ($left='', $top='', $right='', $bottom='')
 
 getCellPaddings ()
 
 setCellMargins ($left='', $top='', $right='', $bottom='')
 
 getCellMargins ()
 
 SetAutoPageBreak ($auto, $margin=0)
 
 getAutoPageBreak ()
 
 SetDisplayMode ($zoom, $layout='SinglePage', $mode='UseNone')
 
 SetCompression ($compress=true)
 
 setSRGBmode ($mode=false)
 
 SetDocInfoUnicode ($unicode=true)
 
 SetTitle ($title)
 
 SetSubject ($subject)
 
 SetAuthor ($author)
 
 SetKeywords ($keywords)
 
 SetCreator ($creator)
 
 Error ($msg)
 
 Open ()
 
 Close ()
 
 setPage ($pnum, $resetmargins=false)
 
 lastPage ($resetmargins=false)
 
 getPage ()
 
 getNumPages ()
 
 addTOCPage ($orientation='', $format='', $keepmargins=false)
 
 endTOCPage ()
 
 AddPage ($orientation='', $format='', $keepmargins=false, $tocpage=false)
 
 endPage ($tocpage=false)
 
 startPage ($orientation='', $format='', $tocpage=false)
 
 setPageMark ()
 
 setHeaderData ($ln='', $lw=0, $ht='', $hs='', $tc=array(0, 0, 0), $lc=array(0, 0, 0))
 
 setFooterData ($tc=array(0, 0, 0), $lc=array(0, 0, 0))
 
 getHeaderData ()
 
 setHeaderMargin ($hm=10)
 
 getHeaderMargin ()
 
 setFooterMargin ($fm=10)
 
 getFooterMargin ()
 
 setPrintHeader ($val=true)
 
 setPrintFooter ($val=true)
 
 getImageRBX ()
 
 getImageRBY ()
 
 resetHeaderTemplate ()
 
 setHeaderTemplateAutoreset ($val=true)
 
 Header ()
 
 Footer ()
 
 PageNo ()
 
 getAllSpotColors ()
 
 AddSpotColor ($name, $c, $m, $y, $k)
 
 setSpotColor ($type, $name, $tint=100)
 
 SetDrawSpotColor ($name, $tint=100)
 
 SetFillSpotColor ($name, $tint=100)
 
 SetTextSpotColor ($name, $tint=100)
 
 setColorArray ($type, $color, $ret=false)
 
 SetDrawColorArray ($color, $ret=false)
 
 SetFillColorArray ($color, $ret=false)
 
 SetTextColorArray ($color, $ret=false)
 
 setColor ($type, $col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='')
 
 SetDrawColor ($col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='')
 
 SetFillColor ($col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='')
 
 SetTextColor ($col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='')
 
 GetStringWidth ($s, $fontname='', $fontstyle='', $fontsize=0, $getarray=false)
 
 GetArrStringWidth ($sa, $fontname='', $fontstyle='', $fontsize=0, $getarray=false)
 
 GetCharWidth ($char, $notlast=true)
 
 getRawCharWidth ($char)
 
 GetNumChars ($s)
 
 unichr ($c)
 
 addTTFfont ($fontfile, $fonttype='', $enc='', $flags=32, $outpath='', $platid=3, $encid=1, $addcbbox=false)
 
 AddFont ($family, $style='', $fontfile='', $subset='default')
 
 SetFont ($family, $style='', $size=null, $fontfile='', $subset='default', $out=true)
 
 SetFontSize ($size, $out=true)
 
 getFontBBox ()
 
 getAbsFontMeasure ($s)
 
 getCharBBox ($char)
 
 getFontDescent ($font, $style='', $size=0)
 
 getFontAscent ($font, $style='', $size=0)
 
 isCharDefined ($char, $font='', $style='')
 
 replaceMissingChars ($text, $font='', $style='', $subs=array())
 
 SetDefaultMonospacedFont ($font)
 
 AddLink ()
 
 SetLink ($link, $y=0, $page=-1)
 
 Link ($x, $y, $w, $h, $link, $spaces=0)
 
 Annotation ($x, $y, $w, $h, $text, $opt=array('Subtype'=>'Text'), $spaces=0)
 
 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)
 
 AcceptPageBreak ()
 
 Cell ($w, $h=0, $txt='', $border=0, $ln=0, $align='', $fill=false, $link='', $stretch=0, $ignore_min_height=false, $calign='T', $valign='M')
 
 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)
 
 getNumLines ($txt, $w=0, $reseth=false, $autopadding=true, $cellpadding='', $border=0)
 
 getStringHeight ($w, $txt, $reseth=false, $autopadding=true, $cellpadding='', $border=0)
 
 Write ($h, $txt, $link='', $fill=false, $align='', $ln=false, $stretch=0, $firstline=false, $firstblock=false, $maxh=0, $wadj=0, $margin='')
 
 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())
 
 Ln ($h='', $cell=false)
 
 GetX ()
 
 GetAbsX ()
 
 GetY ()
 
 SetX ($x, $rtloff=false)
 
 SetY ($y, $resetx=true, $rtloff=false)
 
 SetXY ($x, $y, $rtloff=false)
 
 SetAbsX ($x)
 
 SetAbsY ($y)
 
 SetAbsXY ($x, $y)
 
 Output ($name='doc.pdf', $dest='I')
 
 _destroy ($destroyall=false, $preserve_objcopy=false)
 
 setExtraXMP ($xmp)
 
 setDocCreationTimestamp ($time)
 
 setDocModificationTimestamp ($time)
 
 getDocCreationTimestamp ()
 
 getDocModificationTimestamp ()
 
 setHeaderFont ($font)
 
 getHeaderFont ()
 
 setFooterFont ($font)
 
 getFooterFont ()
 
 setLanguageArray ($language)
 
 getPDFData ()
 
 addHtmlLink ($url, $name, $fill=false, $firstline=false, $color='', $style=-1, $firstblock=false)
 
 pixelsToUnits ($px)
 
 unhtmlentities ($text_to_convert)
 
 SetProtection ($permissions=array('print', 'modify', 'copy', 'annot-forms', 'fill-forms', 'extract', 'assemble', 'print-high'), $user_pass='', $owner_pass=null, $mode=0, $pubkeys=null)
 
 StartTransform ()
 
 StopTransform ()
 
 ScaleX ($s_x, $x='', $y='')
 
 ScaleY ($s_y, $x='', $y='')
 
 ScaleXY ($s, $x='', $y='')
 
 Scale ($s_x, $s_y, $x='', $y='')
 
 MirrorH ($x='')
 
 MirrorV ($y='')
 
 MirrorP ($x='', $y='')
 
 MirrorL ($angle=0, $x='', $y='')
 
 TranslateX ($t_x)
 
 TranslateY ($t_y)
 
 Translate ($t_x, $t_y)
 
 Rotate ($angle, $x='', $y='')
 
 SkewX ($angle_x, $x='', $y='')
 
 SkewY ($angle_y, $x='', $y='')
 
 Skew ($angle_x, $angle_y, $x='', $y='')
 
 SetLineWidth ($width)
 
 GetLineWidth ()
 
 SetLineStyle ($style, $ret=false)
 
 Line ($x1, $y1, $x2, $y2, $style=array())
 
 Rect ($x, $y, $w, $h, $style='', $border_style=array(), $fill_color=array())
 
 Curve ($x0, $y0, $x1, $y1, $x2, $y2, $x3, $y3, $style='', $line_style=array(), $fill_color=array())
 
 Polycurve ($x0, $y0, $segments, $style='', $line_style=array(), $fill_color=array())
 
 Ellipse ($x0, $y0, $rx, $ry='', $angle=0, $astart=0, $afinish=360, $style='', $line_style=array(), $fill_color=array(), $nc=2)
 
 Circle ($x0, $y0, $r, $angstr=0, $angend=360, $style='', $line_style=array(), $fill_color=array(), $nc=2)
 
 PolyLine ($p, $style='', $line_style=array(), $fill_color=array())
 
 Polygon ($p, $style='', $line_style=array(), $fill_color=array(), $closed=true)
 
 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())
 
 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())
 
 RoundedRect ($x, $y, $w, $h, $r, $round_corner='1111', $style='', $border_style=array(), $fill_color=array())
 
 RoundedRectXY ($x, $y, $w, $h, $rx, $ry, $round_corner='1111', $style='', $border_style=array(), $fill_color=array())
 
 Arrow ($x0, $y0, $x1, $y1, $head_style=0, $arm_size=5, $arm_angle=15)
 
 setDestination ($name, $y=-1, $page='', $x=-1)
 
 getDestination ()
 
 setBookmark ($txt, $level=0, $y=-1, $page='', $style='', $color=array(0, 0, 0), $x=-1, $link='')
 
 Bookmark ($txt, $level=0, $y=-1, $page='', $style='', $color=array(0, 0, 0), $x=-1, $link='')
 
 IncludeJS ($script)
 
 addJavascriptObject ($script, $onload=false)
 
 setFormDefaultProp ($prop=array())
 
 getFormDefaultProp ()
 
 TextField ($name, $w, $h, $prop=array(), $opt=array(), $x='', $y='', $js=false)
 
 RadioButton ($name, $w, $prop=array(), $opt=array(), $onvalue='On', $checked=false, $x='', $y='', $js=false)
 
 ListBox ($name, $w, $h, $values, $prop=array(), $opt=array(), $x='', $y='', $js=false)
 
 ComboBox ($name, $w, $h, $values, $prop=array(), $opt=array(), $x='', $y='', $js=false)
 
 CheckBox ($name, $w, $checked=false, $prop=array(), $opt=array(), $onvalue='Yes', $x='', $y='', $js=false)
 
 Button ($name, $w, $h, $caption, $action, $prop=array(), $opt=array(), $x='', $y='', $js=false)
 
 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='')
 
 setSignature ($signing_cert='', $private_key='', $private_key_password='', $extracerts='', $cert_type=2, $info=array())
 
 setSignatureAppearance ($x=0, $y=0, $w=0, $h=0, $page=-1, $name='')
 
 addEmptySignatureAppearance ($x=0, $y=0, $w=0, $h=0, $page=-1, $name='')
 
 startPageGroup ($page='')
 
 setStartingPageNumber ($num=1)
 
 getAliasRightShift ()
 
 getAliasNbPages ()
 
 getAliasNumPage ()
 
 getPageGroupAlias ()
 
 getPageNumGroupAlias ()
 
 getGroupPageNo ()
 
 getGroupPageNoFormatted ()
 
 PageNoFormatted ()
 
 startLayer ($name='', $print=true, $view=true)
 
 endLayer ()
 
 setVisibility ($v)
 
 setOverprint ($stroking=true, $nonstroking='', $mode=0)
 
 getOverprint ()
 
 setAlpha ($stroking=1, $bm='Normal', $nonstroking='', $ais=false)
 
 getAlpha ()
 
 setJPEGQuality ($quality)
 
 setDefaultTableColumns ($cols=4)
 
 setCellHeightRatio ($h)
 
 getCellHeightRatio ()
 
 setPDFVersion ($version='1.7')
 
 setViewerPreferences ($preferences)
 
 colorRegistrationBar ($x, $y, $w, $h, $transition=true, $vertical=false, $colors='A, R, G, B, C, M, Y, K')
 
 cropMark ($x, $y, $w, $h, $type='T, R, B, L', $color=array(100, 100, 100, 100,'All'))
 
 registrationMark ($x, $y, $r, $double=false, $cola=array(100, 100, 100, 100,'All'), $colb=array(0, 0, 0, 0,'None'))
 
 registrationMarkCMYK ($x, $y, $r)
 
 LinearGradient ($x, $y, $w, $h, $col1=array(), $col2=array(), $coords=array(0, 0, 1, 0))
 
 RadialGradient ($x, $y, $w, $h, $col1=array(), $col2=array(), $coords=array(0.5, 0.5, 0.5, 0.5, 1))
 
 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)
 
 Gradient ($type, $coords, $stops, $background=array(), $antialias=false)
 
 PieSector ($xc, $yc, $r, $a, $b, $style='FD', $cw=true, $o=90)
 
 PieSectorXY ($xc, $yc, $rx, $ry, $a, $b, $style='FD', $cw=false, $o=0, $nc=2)
 
 ImageEps ($file, $x='', $y='', $w=0, $h=0, $link='', $useBoundingBox=true, $align='', $palign='', $border=0, $fitonpage=false, $fixoutvals=false)
 
 setBarcode ($bc='')
 
 getBarcode ()
 
 write1DBarcode ($code, $type, $x='', $y='', $w='', $h='', $xres='', $style='', $align='')
 
 write2DBarcode ($code, $type, $x='', $y='', $w='', $h='', $style='', $align='', $distort=false)
 
 getMargins ()
 
 getOriginalMargins ()
 
 getFontSize ()
 
 getFontSizePt ()
 
 getFontFamily ()
 
 getFontStyle ()
 
 fixHTMLCode ($html, $default_css='', $tagvs='', $tidy_options='')
 
 getCSSPadding ($csspadding, $width=0)
 
 getCSSMargin ($cssmargin, $width=0)
 
 getCSSBorderMargin ($cssbspace, $width=0)
 
 getHTMLFontUnits ($val, $refsize=12, $parent_size=12, $defaultunit='pt')
 
 serializeTCPDFtagParameters ($pararray)
 
 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='')
 
 setLIsymbol ($symbol='!')
 
 SetBooklet ($booklet=true, $inner=-1, $outer=-1)
 
 setHtmlVSpace ($tagvs)
 
 setListIndentWidth ($width)
 
 setOpenCell ($isopen)
 
 setHtmlLinksStyle ($color=array(0, 0, 255), $fontstyle='U')
 
 getHTMLUnitToUnits ($htmlval, $refsize=1, $defaultunit='px', $points=false)
 
 movePage ($frompage, $topage)
 
 deletePage ($page)
 
 copyPage ($page=0)
 
 addTOC ($page='', $numbersfont='', $filler='.', $toc_name='TOC', $style='', $color=array(0, 0, 0))
 
 addHTMLTOC ($page='', $toc_name='TOC', $templates=array(), $correct_align=true, $style='', $color=array(0, 0, 0))
 
 startTransaction ()
 
 commitTransaction ()
 
 rollbackTransaction ($self=false)
 
 setEqualColumns ($numcols=0, $width=0, $y='')
 
 resetColumns ()
 
 setColumnsArray ($columns)
 
 selectColumn ($col='')
 
 getColumn ()
 
 getNumberOfColumns ()
 
 setTextRenderingMode ($stroke=0, $fill=true, $clip=false)
 
 setTextShadow ($params=array('enabled'=>false, 'depth_w'=>0, 'depth_h'=>0, 'color'=>false, 'opacity'=>1, 'blend_mode'=>'Normal'))
 
 getTextShadow ()
 
 hyphenateText ($text, $patterns, $dictionary=array(), $leftmin=1, $rightmin=2, $charmin=1, $charmax=8)
 
 setRasterizeVectorImages ($mode)
 
 setFontSubsetting ($enable=true)
 
 getFontSubsetting ()
 
 stringLeftTrim ($str, $replace='')
 
 stringRightTrim ($str, $replace='')
 
 stringTrim ($str, $replace='')
 
 isUnicodeFont ()
 
 getFontFamilyName ($fontfamily)
 
 startTemplate ($w=0, $h=0, $group=false)
 
 endTemplate ()
 
 printTemplate ($id, $x='', $y='', $w=0, $h=0, $align='', $palign='', $fitonpage=false)
 
 setFontStretching ($perc=100)
 
 getFontStretching ()
 
 setFontSpacing ($spacing=0)
 
 getFontSpacing ()
 
 getPageRegions ()
 
 setPageRegions ($regions=array())
 
 addPageRegion ($region)
 
 removePageRegion ($key)
 
 ImageSVG ($file, $x='', $y='', $w=0, $h=0, $link='', $align='', $palign='', $border=0, $fitonpage=false)
 

Geschützte Methoden

 setPageFormat ($format, $orientation='P')
 
 adjustCellPadding ($brd=0)
 
 setContentMark ($page=0)
 
 setHeader ()
 
 setFooter ()
 
 inPageBody ()
 
 setTableHeader ()
 
 getFontsList ()
 
 _putEmbeddedFiles ()
 
 checkPageBreak ($h=0, $y='', $addpage=true)
 
 getCellCode ($w, $h=0, $txt='', $border=0, $ln=0, $align='', $fill=false, $link='', $stretch=0, $ignore_min_height=false, $calign='T', $valign='M')
 
 replaceChar ($oldchar, $newchar)
 
 getCellBorder ($x, $y, $w, $h, $brd)
 
 getRemainingWidth ()
 
 fitBlock ($w, $h, $x, $y, $fitonpage=false)
 
 ImagePngAlpha ($file, $x, $y, $wpx, $hpx, $w, $h, $type, $link, $align, $resize, $dpi, $palign, $filehash='')
 
 getGDgamma ($img, $c)
 
 _dochecks ()
 
 getInternalPageNumberAliases ($a= '')
 
 getAllInternalPageNumberAliases ()
 
 replaceRightShiftPageNumAliases ($page, $aliases, $diff)
 
 setPageBoxTypes ($boxes)
 
 _putpages ()
 
 _putannotsrefs ($n)
 
 _getannotsrefs ($n)
 
 _putannotsobjs ()
 
 _putAPXObject ($w=0, $h=0, $stream='')
 
 _putfonts ()
 
 _puttruetypeunicode ($font)
 
 _putcidfont0 ($font)
 
 _putimages ()
 
 _putxobjects ()
 
 _putspotcolors ()
 
 _getxobjectdict ()
 
 _putresourcedict ()
 
 _putresources ()
 
 _putinfo ()
 
 _putXMP ()
 
 _putcatalog ()
 
 _putviewerpreferences ()
 
 _putheader ()
 
 _enddoc ()
 
 _beginpage ($orientation='', $format='')
 
 _endpage ()
 
 _newobj ()
 
 _getobj ($objid='')
 
 _dounderline ($x, $y, $txt)
 
 _dounderlinew ($x, $y, $w)
 
 _dolinethrough ($x, $y, $txt)
 
 _dolinethroughw ($x, $y, $w)
 
 _dooverline ($x, $y, $txt)
 
 _dooverlinew ($x, $y, $w)
 
 _datastring ($s, $n=0)
 
 _datestring ($n=0, $timestamp=0)
 
 _textstring ($s, $n=0)
 
 _escapetext ($s)
 
 _getrawstream ($s, $n=0)
 
 _getstream ($s, $n=0)
 
 _putstream ($s, $n=0)
 
 _out ($s)
 
 _objectkey ($n)
 
 _encrypt_data ($n, $s)
 
 _putencryption ()
 
 _Uvalue ()
 
 _UEvalue ()
 
 _Ovalue ()
 
 _OEvalue ()
 
 _fixAES256Password ($password)
 
 _generateencryptionkey ()
 
 Transform ($tm)
 
 _outPoint ($x, $y)
 
 _outLine ($x, $y)
 
 _outRect ($x, $y, $w, $h, $op)
 
 _outCurve ($x1, $y1, $x2, $y2, $x3, $y3)
 
 _outCurveV ($x2, $y2, $x3, $y3)
 
 _outCurveY ($x1, $y1, $x3, $y3)
 
 _outellipticalarc ($xc, $yc, $rx, $ry, $xang=0, $angs=0, $angf=360, $pie=false, $nc=2, $startpoint=true, $ccw=true, $svg=false)
 
 _putdests ()
 
 sortBookmarks ()
 
 _putbookmarks ()
 
 _putjavascript ()
 
 _addfield ($type, $name, $x, $y, $w, $h, $prop)
 
 _putsignature ()
 
 getSignatureAppearanceArray ($x=0, $y=0, $w=0, $h=0, $page=-1, $name='')
 
 _putocg ()
 
 addExtGState ($parms)
 
 setExtGState ($gs)
 
 _putextgstates ()
 
 Clip ($x, $y, $w, $h)
 
 _putshaders ()
 
 getCSSBorderWidth ($width)
 
 getCSSBorderDashStyle ($style)
 
 getCSSBorderStyle ($cssborder)
 
 getCSSFontSpacing ($spacing, $parent=0)
 
 getCSSFontStretching ($stretch, $parent=100)
 
 getHtmlDomArray ($html)
 
 getSpaceString ()
 
 openHTMLTagHandler ($dom, $key, $cell)
 
 closeHTMLTagHandler ($dom, $key, $cell, $maxbottomliney=0)
 
 addHTMLVertSpace ($hbz=0, $hb=0, $cell=false, $firsttag=false, $lasttag=false)
 
 getBorderStartPosition ()
 
 drawHTMLTagBorder ($tag, $xmax)
 
 swapMargins ($reverse=true)
 
 putHtmlListBullet ($listdepth, $listtype='', $size=10)
 
 getGraphicVars ()
 
 setGraphicVars ($gvars, $extended=false)
 
 _outSaveGraphicsState ()
 
 _outRestoreGraphicsState ()
 
 writeDiskCache ($filename, $data, $append=false)
 
 readDiskCache ($filename)
 
 setBuffer ($data)
 
 replaceBuffer ($data)
 
 getBuffer ()
 
 setPageBuffer ($page, $data, $append=false)
 
 getPageBuffer ($page)
 
 setImageBuffer ($image, $data)
 
 setImageSubBuffer ($image, $key, $data)
 
 getImageBuffer ($image)
 
 setFontBuffer ($font, $data)
 
 setFontSubBuffer ($font, $key, $data)
 
 getFontBuffer ($font)
 
 hyphenateWord ($word, $patterns, $dictionary=array(), $leftmin=1, $rightmin=2, $charmin=1, $charmax=8)
 
 checkPageRegions ($h, $x, $y)
 
 convertSVGtMatrix ($tm)
 
 SVGTransform ($tm)
 
 setSVGStyles ($svgstyle, $prevsvgstyle, $x=0, $y=0, $w=1, $h=1, $clip_function='', $clip_params=array())
 
 SVGPath ($d, $style='')
 
 startSVGElementHandler ($parser, $name, $attribs, $ctm=array())
 
 endSVGElementHandler ($parser, $name)
 
 segSVGContentHandler ($parser, $data)
 

Geschützte Attribute

 $page
 
 $n
 
 $offsets = array()
 
 $pageobjects = array()
 
 $buffer
 
 $pages = array()
 
 $state
 
 $compress
 
 $CurOrientation
 
 $pagedim = array()
 
 $k
 
 $fwPt
 
 $fhPt
 
 $wPt
 
 $hPt
 
 $w
 
 $h
 
 $lMargin
 
 $rMargin
 
 $clMargin
 
 $crMargin
 
 $tMargin
 
 $bMargin
 
 $cell_padding = array('T' => 0, 'R' => 0, 'B' => 0, 'L' => 0)
 
 $cell_margin = array('T' => 0, 'R' => 0, 'B' => 0, 'L' => 0)
 
 $x
 
 $y
 
 $lasth
 
 $LineWidth
 
 $CoreFonts
 
 $fonts = array()
 
 $FontFiles = array()
 
 $diffs = array()
 
 $images = array()
 
 $cached_files = array()
 
 $PageAnnots = array()
 
 $links = array()
 
 $FontFamily
 
 $FontStyle
 
 $FontAscent
 
 $FontDescent
 
 $underline
 
 $overline
 
 $CurrentFont
 
 $FontSizePt
 
 $FontSize
 
 $DrawColor
 
 $FillColor
 
 $TextColor
 
 $ColorFlag
 
 $AutoPageBreak
 
 $PageBreakTrigger
 
 $InHeader = false
 
 $InFooter = false
 
 $ZoomMode
 
 $LayoutMode
 
 $docinfounicode = true
 
 $title = ''
 
 $subject = ''
 
 $author = ''
 
 $keywords = ''
 
 $creator = ''
 
 $starting_page_number = 1
 
 $img_rb_x
 
 $img_rb_y
 
 $imgscale = 1
 
 $isunicode = false
 
 $PDFVersion = '1.7'
 
 $header_xobjid = false
 
 $header_xobj_autoreset = false
 
 $header_margin
 
 $footer_margin
 
 $original_lMargin
 
 $original_rMargin
 
 $header_font
 
 $footer_font
 
 $l
 
 $barcode = false
 
 $print_header = true
 
 $print_footer = true
 
 $header_logo = ''
 
 $header_logo_width = 30
 
 $header_title = ''
 
 $header_string = ''
 
 $header_text_color = array(0,0,0)
 
 $header_line_color = array(0,0,0)
 
 $footer_text_color = array(0,0,0)
 
 $footer_line_color = array(0,0,0)
 
 $txtshadow = array('enabled'=>false, 'depth_w'=>0, 'depth_h'=>0, 'color'=>false, 'opacity'=>1, 'blend_mode'=>'Normal')
 
 $default_table_columns = 4
 
 $HREF = array()
 
 $fontlist = array()
 
 $fgcolor
 
 $listordered = array()
 
 $listcount = array()
 
 $listnum = 0
 
 $listindent = 0
 
 $listindentlevel = 0
 
 $bgcolor
 
 $tempfontsize = 10
 
 $lispacer = ''
 
 $encoding = 'UTF-8'
 
 $internal_encoding
 
 $rtl = false
 
 $tmprtl = false
 
 $encrypted
 
 $encryptdata = array()
 
 $last_enc_key
 
 $last_enc_key_c
 
 $file_id
 
 $outlines = array()
 
 $OutlineRoot
 
 $javascript = ''
 
 $n_js
 
 $linethrough
 
 $ur = array()
 
 $dpi = 72
 
 $newpagegroup = array()
 
 $pagegroups = array()
 
 $currpagegroup = 0
 
 $extgstates
 
 $jpeg_quality
 
 $cell_height_ratio = K_CELL_HEIGHT_RATIO
 
 $viewer_preferences
 
 $PageMode
 
 $gradients = array()
 
 $intmrk = array()
 
 $bordermrk = array()
 
 $emptypagemrk = array()
 
 $cntmrk = array()
 
 $footerpos = array()
 
 $footerlen = array()
 
 $newline = true
 
 $endlinex = 0
 
 $linestyleWidth = ''
 
 $linestyleCap = '0 J'
 
 $linestyleJoin = '0 j'
 
 $linestyleDash = '[] 0 d'
 
 $openMarkedContent = false
 
 $htmlvspace = 0
 
 $spot_colors = array()
 
 $lisymbol = ''
 
 $epsmarker = 'x#!#EPS#!#x'
 
 $transfmatrix = array()
 
 $transfmatrix_key = 0
 
 $booklet = false
 
 $feps = 0.005
 
 $tagvspaces = array()
 
 $customlistindent = -1
 
 $opencell = true
 
 $embeddedfiles = array()
 
 $premode = false
 
 $transfmrk = array()
 
 $htmlLinkColorArray = array(0, 0, 255)
 
 $htmlLinkFontStyle = 'U'
 
 $numpages = 0
 
 $pagelen = array()
 
 $numimages = 0
 
 $imagekeys = array()
 
 $bufferlen = 0
 
 $diskcache = false
 
 $numfonts = 0
 
 $fontkeys = array()
 
 $font_obj_ids = array()
 
 $pageopen = array()
 
 $default_monospaced_font = 'courier'
 
 $objcopy
 
 $cache_file_length = array()
 
 $thead = ''
 
 $theadMargins = array()
 
 $sign = false
 
 $signature_data = array()
 
 $signature_max_length = 11742
 
 $signature_appearance = array('page' => 1, 'rect' => '0 0 0 0')
 
 $empty_signature_appearance = array()
 
 $re_spaces = '/[^\S\xa0]/'
 
 $re_space = array('p' => '[^\S\xa0]', 'm' => '')
 
 $sig_obj_id = 0
 
 $page_obj_id = array()
 
 $form_obj_id = array()
 
 $default_form_prop = array('lineWidth'=>1, 'borderStyle'=>'solid', 'fillColor'=>array(255, 255, 255), 'strokeColor'=>array(128, 128, 128))
 
 $js_objects = array()
 
 $form_action = ''
 
 $form_enctype = 'application/x-www-form-urlencoded'
 
 $form_mode = 'post'
 
 $annotation_fonts = array()
 
 $radiobutton_groups = array()
 
 $radio_groups = array()
 
 $textindent = 0
 
 $start_transaction_page = 0
 
 $start_transaction_y = 0
 
 $inthead = false
 
 $columns = array()
 
 $num_columns = 1
 
 $current_column = 0
 
 $column_start_page = 0
 
 $maxselcol = array('page' => 0, 'column' => 0)
 
 $colxshift = array('x' => 0, 's' => array('H' => 0, 'V' => 0), 'p' => array('L' => 0, 'T' => 0, 'R' => 0, 'B' => 0))
 
 $textrendermode = 0
 
 $textstrokewidth = 0
 
 $strokecolor
 
 $pdfunit = 'mm'
 
 $tocpage = false
 
 $rasterize_vector_images = false
 
 $font_subsetting = true
 
 $default_graphic_vars = array()
 
 $xobjects = array()
 
 $inxobj = false
 
 $xobjid = ''
 
 $font_stretching = 100
 
 $font_spacing = 0
 
 $page_regions = array()
 
 $check_page_regions = true
 
 $pdflayers = array()
 
 $dests = array()
 
 $n_dests
 
 $efnames = array()
 
 $svgdir = ''
 
 $svgunit = 'px'
 
 $svggradients = array()
 
 $svggradientid = 0
 
 $svgdefsmode = false
 
 $svgdefs = array()
 
 $svgclipmode = false
 
 $svgclippaths = array()
 
 $svgcliptm = array()
 
 $svgclipid = 0
 
 $svgtext = ''
 
 $svgtextmode = array()
 
 $svgstyles
 
 $force_srgb = false
 
 $pdfa_mode = false
 
 $doc_creation_timestamp
 
 $doc_modification_timestamp
 
 $custom_xmp = ''
 
 $overprint = array('OP' => false, 'op' => false, 'OPM' => 0)
 
 $alpha = array('CA' => 1, 'ca' => 1, 'BM' => '/Normal', 'AIS' => false)
 
 $page_boxes = array('MediaBox', 'CropBox', 'BleedBox', 'TrimBox', 'ArtBox')
 
 $tcpdflink = true
 
 $gdgammacache = array()
 

Ausführliche Beschreibung

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.

Definiert in Zeile 134 der Datei tcpdf.php.

Beschreibung der Konstruktoren und Destruktoren

__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.

Parameter
$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) If TRUE reduce the RAM memory usage by caching temporary data on filesystem (slower).
$pdfa(boolean) If TRUE set the document to PDF/A mode.
Siehe auch
getPageSizeFromFormat(), setPageFormat()

Definiert in Zeile 1831 der Datei tcpdf.php.

Benutzt $diskcache, $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() und TCPDF_FONTS\utf8Bidi().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

__destruct ( )

Default destructor.

Seit
1.53.0.TC016

Definiert in Zeile 1984 der Datei tcpdf.php.

Benutzt _destroy().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Dokumentation der Elementfunktionen

_addfield (   $type,
  $name,
  $x,
  $y,
  $w,
  $h,
  $prop 
)
protected

Adds a javascript form field.

Parameter
$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.
Autor
Denis Van Nuffelen, Nicola Asuni
Seit
2.1.002 (2008-02-12)

Definiert in Zeile 12590 der Datei tcpdf.php.

Benutzt $h, $k, $w, $x, $y und TCPDF_COLORS\_JScolor().

Wird benutzt von Button(), ListBox(), RadioButton() und TextField().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_beginpage (   $orientation = '',
  $format = '' 
)
protected

Initialize a new page.

Parameter
$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().
Siehe auch
getPageSizeFromFormat(), setPageFormat()

Definiert in Zeile 9984 der Datei tcpdf.php.

Benutzt $CurOrientation, $currpagegroup, $lMargin, $page, $rMargin, $tMargin, TCPDF_STATIC\empty_string(), setPageBuffer(), setPageFormat() und setPageOrientation().

Wird benutzt von startPage().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_datastring (   $s,
  $n = 0 
)
protected

Format a data string for meta information

Parameter
$s(string) data string to escape.
$n(int) object ID
Rückgabe
string escaped string.

Definiert in Zeile 10143 der Datei tcpdf.php.

Benutzt $n, _encrypt_data() und TCPDF_STATIC\_escape().

Wird benutzt von _datestring() und _textstring().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_datestring (   $n = 0,
  $timestamp = 0 
)
protected

Returns a formatted date for meta information

Parameter
$n(int) Object ID.
$timestamp(int) Timestamp to convert.
Rückgabe
string escaped date string.
Seit
4.6.028 (2009-08-25)

Definiert in Zeile 10205 der Datei tcpdf.php.

Benutzt $doc_creation_timestamp, $n, _datastring() und TCPDF_STATIC\getFormattedDate().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

_destroy (   $destroyall = false,
  $preserve_objcopy = false 
)

Unset all class variables except the following critical variables.

Parameter
$destroyall(boolean) if true destroys all class variables, otherwise preserves critical variables.
$preserve_objcopy(boolean) if true preserves the objcopy variable
Seit
4.5.016 (2009-02-24)

Definiert in Zeile 7739 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\empty_string().

Wird benutzt von __destruct(), Close() und Error().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_dochecks ( )
protected

Check for locale-related bug

Definiert in Zeile 7777 der Datei tcpdf.php.

Benutzt Error().

Wird benutzt von __construct().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_dolinethrough (   $x,
  $y,
  $txt 
)
protected

Line through text.

Parameter
$x(int) X coordinate
$y(int) Y coordinate
$txt(string) text to linethrough

Definiert in Zeile 10091 der Datei tcpdf.php.

Benutzt $w, $x, $y, _dolinethroughw() und GetStringWidth().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

_dolinethroughw (   $x,
  $y,
  $w 
)
protected

Line through for rectangular text area.

Parameter
$x(int) X coordinate
$y(int) Y coordinate
$w(int) line length (width)
Seit
4.9.008 (2009-09-29)

Definiert in Zeile 10104 der Datei tcpdf.php.

Benutzt $FontSizePt, $w, $x und $y.

Wird benutzt von _dolinethrough().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_dooverline (   $x,
  $y,
  $txt 
)
protected

Overline text.

Parameter
$x(int) X coordinate
$y(int) Y coordinate
$txt(string) text to overline
Seit
4.9.015 (2010-04-19)

Definiert in Zeile 10117 der Datei tcpdf.php.

Benutzt $w, $x, $y, _dooverlinew() und GetStringWidth().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

_dooverlinew (   $x,
  $y,
  $w 
)
protected

Overline for rectangular text area.

Parameter
$x(int) X coordinate
$y(int) Y coordinate
$w(int) width to overline
Seit
4.9.015 (2010-04-19)

Definiert in Zeile 10130 der Datei tcpdf.php.

Benutzt $FontSizePt, $w, $x und $y.

Wird benutzt von _dooverline().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_dounderline (   $x,
  $y,
  $txt 
)
protected

Underline text.

Parameter
$x(int) X coordinate
$y(int) Y coordinate
$txt(string) text to underline

Definiert in Zeile 10066 der Datei tcpdf.php.

Benutzt $w, $x, $y, _dounderlinew() und GetStringWidth().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

_dounderlinew (   $x,
  $y,
  $w 
)
protected

Underline for rectangular text area.

Parameter
$x(int) X coordinate
$y(int) Y coordinate
$w(int) width to underline
Seit
4.8.008 (2009-09-29)

Definiert in Zeile 10079 der Datei tcpdf.php.

Benutzt $FontSizePt, $w, $x und $y.

Wird benutzt von _dounderline().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_encrypt_data (   $n,
  $s 
)
protected

Encrypt the input string.

Parameter
$n(int) object number
$s(string) data string to encrypt
Rückgabe
encrypted string
Autor
Nicola Asuni
Seit
5.0.005 (2010-05-11)

Definiert in Zeile 10482 der Datei tcpdf.php.

Benutzt $n, TCPDF_STATIC\_AES(), _objectkey() und TCPDF_STATIC\_RC4().

Wird benutzt von _datastring() und _getrawstream().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_enddoc ( )
protected

Output end of document (EOF).

Definiert in Zeile 9882 der Datei tcpdf.php.

Benutzt $bufferlen, $n, _getobj(), _out(), _putcatalog(), _putheader(), _putinfo(), _putpages(), _putresources(), _putsignature() und setFontSubBuffer().

Wird benutzt von Close().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_endpage ( )
protected

Mark end of page.

Definiert in Zeile 10027 der Datei tcpdf.php.

Benutzt setVisibility().

Wird benutzt von endPage().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_escapetext (   $s)
protected

THIS METHOD IS DEPRECATED Format a text string

Parameter
$s(string) string to escape.
Rückgabe
string escaped string.
Veraltet:

Definiert in Zeile 10235 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\_escape(), TCPDF_FONTS\utf8StrRev() und TCPDF_FONTS\UTF8ToLatin1().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

_fixAES256Password (   $password)
protected

Convert password for AES-256 encryption mode

Parameter
$password(string) password
Rückgabe
string password
Seit
5.9.006 (2010-10-19)
Autor
Nicola Asuni

Definiert in Zeile 10728 der Datei tcpdf.php.

Benutzt TCPDF_FONTS\unichr(), TCPDF_FONTS\utf8Bidi() und TCPDF_FONTS\UTF8StringToArray().

Wird benutzt von _generateencryptionkey().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_generateencryptionkey ( )
protected

Compute encryption key

Seit
2.0.000 (2008-01-02)
Autor
Nicola Asuni

Definiert in Zeile 10743 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\$enc_padding, _fixAES256Password(), TCPDF_STATIC\_md5_16(), _OEvalue(), _Ovalue(), _UEvalue(), _Uvalue(), Error(), TCPDF_STATIC\getEncPermissionsString(), TCPDF_STATIC\getObjFilename(), TCPDF_STATIC\getRandomSeed() und TCPDF_STATIC\getUserPermissionCode().

Wird benutzt von SetProtection().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_getannotsrefs (   $n)
protected

Get references to page annotations.

Parameter
$n(int) page number
Rückgabe
string
Autor
Nicola Asuni
Seit
5.0.010 (2010-05-17)

Definiert in Zeile 8057 der Datei tcpdf.php.

Benutzt $n.

Wird benutzt von _putannotsrefs() und _putpages().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_getobj (   $objid = '')
protected

Return the starting object string for the selected object ID.

Parameter
$objid(int) Object ID (leave empty to get a new ID).
Rückgabe
string the starting object string
Seit
5.8.009 (2010-08-20)

Definiert in Zeile 10049 der Datei tcpdf.php.

Benutzt $bufferlen, $n und $page.

Wird benutzt von _enddoc(), _newobj(), _putannotsobjs(), _putAPXObject(), _putcidfont0(), _putEmbeddedFiles(), _putfonts(), _putjavascript(), _putpages(), _putresourcedict(), _putsignature(), _puttruetypeunicode() und _putxobjects().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_getrawstream (   $s,
  $n = 0 
)
protected

get raw output stream.

Parameter
$s(string) string to output.
$n(int) object reference for encryption mode
Autor
Nicola Asuni
Seit
5.5.000 (2010-06-22)

Definiert in Zeile 10255 der Datei tcpdf.php.

Benutzt $n und _encrypt_data().

Wird benutzt von _getstream(), _putAPXObject(), _putcatalog(), _putEmbeddedFiles(), _putfonts(), _putimages(), _putpages(), _putshaders(), _puttruetypeunicode() und _putxobjects().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_getstream (   $s,
  $n = 0 
)
protected

Format output stream (DEPRECATED).

Parameter
$s(string) string to output.
$n(int) object reference for encryption mode
Veraltet:

Definiert in Zeile 10270 der Datei tcpdf.php.

Benutzt $n und _getrawstream().

Wird benutzt von _putstream().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_getxobjectdict ( )
protected

Return XObjects Dictionary.

Rückgabe
string XObjects dictionary
Seit
5.8.014 (2010-08-23)

Definiert in Zeile 9320 der Datei tcpdf.php.

Wird benutzt von _putresourcedict().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_newobj ( )
protected

Begin a new object and return the object number.

Rückgabe
int object number

Definiert in Zeile 10037 der Datei tcpdf.php.

Benutzt $n, _getobj() und _out().

Wird benutzt von _putbookmarks(), _putcatalog(), _putcidfont0(), _putdests(), _putencryption(), _putextgstates(), _putfonts(), _putimages(), _putinfo(), _putjavascript(), _putocg(), _putpages(), _putshaders(), _putspotcolors(), _puttruetypeunicode() und _putXMP().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_objectkey (   $n)
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.

Parameter
$n(int) object number
Rückgabe
int object key
Autor
Nicola Asuni
Seit
2.0.000 (2008-01-02)

Definiert in Zeile 10462 der Datei tcpdf.php.

Benutzt $n und TCPDF_STATIC\_md5_16().

Wird benutzt von _encrypt_data().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_OEvalue ( )
protected

Compute OE value (used for encryption)

Rückgabe
string OE value
Seit
5.9.006 (2010-10-19)
Autor
Nicola Asuni

Definiert in Zeile 10714 der Datei tcpdf.php.

Wird benutzt von _generateencryptionkey().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_outCurve (   $x1,
  $y1,
  $x2,
  $y2,
  $x3,
  $y3 
)
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).

Parameter
$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.
Seit
2.1.000 (2008-01-08)

Definiert in Zeile 11454 der Datei tcpdf.php.

Benutzt _out().

Wird benutzt von _outellipticalarc(), Curve(), Polycurve() und RoundedRectXY().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_outCurveV (   $x2,
  $y2,
  $x3,
  $y3 
)
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).

Parameter
$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.
Seit
4.9.019 (2010-04-26)

Definiert in Zeile 11470 der Datei tcpdf.php.

Benutzt _out().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

_outCurveY (   $x1,
  $y1,
  $x3,
  $y3 
)
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).

Parameter
$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.
Seit
2.1.000 (2008-01-08)

Definiert in Zeile 11486 der Datei tcpdf.php.

Benutzt _out().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

_outellipticalarc (   $xc,
  $yc,
  $rx,
  $ry,
  $xang = 0,
  $angs = 0,
  $angf = 360,
  $pie = false,
  $nc = 2,
  $startpoint = true,
  $ccw = true,
  $svg = false 
)
protected

Append an elliptical arc to the current path. An ellipse is formed from n Bezier curves.

Parameter
$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).
Rückgabe
array bounding box coordinates (x min, y min, x max, y max)
Autor
Nicola Asuni
Seit
4.9.019 (2010-04-26)

Definiert in Zeile 11715 der Datei tcpdf.php.

Benutzt $alpha, $k, _outCurve(), _outLine() und _outPoint().

Wird benutzt von Ellipse() und PieSectorXY().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_outLine (   $x,
  $y 
)
protected

Append a straight line segment from the current point to the point (x, y). The new current point shall be (x, y).

Parameter
$x(float) Abscissa of end point.
$y(float) Ordinate of end point.
Seit
2.1.000 (2008-01-08)

Definiert in Zeile 11420 der Datei tcpdf.php.

Benutzt $x, $y und _out().

Wird benutzt von _outellipticalarc(), Line(), Polygon() und RoundedRectXY().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_outPoint (   $x,
  $y 
)
protected

Begin a new subpath by moving the current point to coordinates (x, y), omitting any connecting line segment.

Parameter
$x(float) Abscissa of point.
$y(float) Ordinate of point.
Seit
2.1.000 (2008-01-08)

Definiert in Zeile 11406 der Datei tcpdf.php.

Benutzt $x, $y und _out().

Wird benutzt von _outellipticalarc(), Curve(), Line(), Polycurve(), Polygon() und RoundedRectXY().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_outRect (   $x,
  $y,
  $w,
  $h,
  $op 
)
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.

Parameter
$x(float) Abscissa of upper-left corner.
$y(float) Ordinate of upper-left corner.
$w(float) Width.
$h(float) Height.
$op(string) options
Seit
2.1.000 (2008-01-08)

Definiert in Zeile 11436 der Datei tcpdf.php.

Benutzt $h, $w, $x, $y und _out().

Wird benutzt von Rect().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_outRestoreGraphicsState ( )
protected

Outputs the "restore graphics state" operator 'Q'

Definiert in Zeile 20556 der Datei tcpdf.php.

Wird benutzt von Close(), CoonsPatchMesh(), Gradient(), setFooter(), setHeader() und StopTransform().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_outSaveGraphicsState ( )
protected

Outputs the "save graphics state" operator 'q'

Definiert in Zeile 20548 der Datei tcpdf.php.

Wird benutzt von Close(), setFooter(), setHeader() und StartTransform().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_Ovalue ( )
protected

Compute O value (used for encryption)

Rückgabe
string O value
Seit
2.0.000 (2008-01-02)
Autor
Nicola Asuni

Definiert in Zeile 10676 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\_md5_16(), TCPDF_STATIC\_RC4() und TCPDF_STATIC\getRandomSeed().

Wird benutzt von _generateencryptionkey().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putannotsobjs ( )
protected

Output annotations objects for all pages. !!! THIS METHOD IS NOT YET COMPLETED !!! See section 12.5 of PDF 32000_2008 reference.

Autor
Nicola Asuni
Seit
4.0.018 (2008-08-06)

Definiert in Zeile 8101 der Datei tcpdf.php.

Benutzt $k, $l, $n, $numpages, _getobj(), _out(), _putAPXObject(), _textstring(), getImageBuffer() und unhtmlentities().

Wird benutzt von _putresources().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putannotsrefs (   $n)
protected

Output references to page annotations

Parameter
$n(int) page number
Autor
Nicola Asuni
Seit
4.7.000 (2008-08-29)
Veraltet:

Definiert in Zeile 8045 der Datei tcpdf.php.

Benutzt $n, _getannotsrefs() und _out().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

_putAPXObject (   $w = 0,
  $h = 0,
  $stream = '' 
)
protected

Put appearance streams XObject used to define annotation's appearance states.

Parameter
$w(int) annotation width
$h(int) annotation height
$stream(string) appearance stream
Rückgabe
int object ID
Seit
4.8.001 (2009-09-09)

Definiert in Zeile 8732 der Datei tcpdf.php.

Benutzt $h, $n, $w, _getobj(), _getrawstream() und _out().

Wird benutzt von _putannotsobjs().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putbookmarks ( )
protected

Create a bookmark PDF string.

Autor
Olivier Plathey, Nicola Asuni
Seit
2.1.002 (2008-02-12)

Definiert in Zeile 12377 der Datei tcpdf.php.

Benutzt $l, $n, $title, _newobj(), _out(), sortBookmarks(), stringTrim() und unhtmlentities().

Wird benutzt von _putresources().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putcatalog ( )
protected

Output Catalog.

Rückgabe
int object id

Definiert in Zeile 9618 der Datei tcpdf.php.

Benutzt _getrawstream(), _newobj(), _out(), _putviewerpreferences(), _putXMP(), TCPDF_STATIC\empty_string() und getFontBuffer().

Wird benutzt von _enddoc().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putcidfont0 (   $font)
protected

Output CID-0 fonts. A Type 0 CIDFont contains glyph descriptions based on the Adobe Type 1 font format

Parameter
$font(array) font data
Autor
Andrew Whitehead, Nicola Asuni, Yukihiro Nakadaira
Seit
3.2.000 (2008-06-23)

Definiert in Zeile 9018 der Datei tcpdf.php.

Benutzt $k, _getobj(), _newobj() und _out().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

_putdests ( )
protected

Insert Named Destinations.

Autor
Johannes G, Nicola Asuni
Seit
5.9.098 (2011-06-23)

Definiert in Zeile 12275 der Datei tcpdf.php.

Benutzt _newobj() und _out().

Wird benutzt von _putresources().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putEmbeddedFiles ( )
protected

Embedd the attached files.

Seit
4.4.000 (2008-12-07)
Siehe auch
Annotation()

Definiert in Zeile 4842 der Datei tcpdf.php.

Benutzt _getobj(), _getrawstream(), _out() und TCPDF_STATIC\fileGetContents().

Wird benutzt von _putresources().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putencryption ( )
protected

Put encryption on PDF document.

Autor
Nicola Asuni
Seit
2.0.000 (2008-01-02)

Definiert in Zeile 10510 der Datei tcpdf.php.

Benutzt _newobj() und _out().

Wird benutzt von _putresources().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putextgstates ( )
protected

Put extgstates for object transparency

Seit
3.0.000 (2008-03-27)

Definiert in Zeile 13798 der Datei tcpdf.php.

Benutzt $k, _newobj() und _out().

Wird benutzt von _putresources().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putfonts ( )
protected

Output fonts.

Autor
Nicola Asuni

Definiert in Zeile 8762 der Datei tcpdf.php.

Benutzt $k, $n, _getobj(), _getrawstream(), TCPDF_FONTS\_getTrueTypeFontSubset(), _newobj(), _out(), TCPDF_STATIC\empty_string(), Error(), TCPDF_STATIC\get_mqr(), getFontBuffer(), TCPDF_FONTS\getFontFullPath() und TCPDF_STATIC\set_mqr().

Wird benutzt von _putresources().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putheader ( )
protected

Output PDF File Header (7.5.2).

Definiert in Zeile 9873 der Datei tcpdf.php.

Benutzt _out().

Wird benutzt von _enddoc().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putimages ( )
protected

Output images.

Definiert in Zeile 9088 der Datei tcpdf.php.

Benutzt $compress, _getrawstream(), _newobj(), _out(), getImageBuffer() und setImageSubBuffer().

Wird benutzt von _putresources().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putinfo ( )
protected

Adds some Metadata information (Document Information Dictionary) (see Chapter 14.3.3 Document Information Dictionary of PDF32000_2008.pdf Reference)

Rückgabe
int object id

Definiert in Zeile 9419 der Datei tcpdf.php.

Benutzt $isunicode, _newobj(), _out(), TCPDF_STATIC\empty_string() und TCPDF_STATIC\getTCPDFProducer().

Wird benutzt von _enddoc().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putjavascript ( )
protected

Create a javascript PDF string.

Autor
Johannes G, Nicola Asuni
Seit
2.1.002 (2008-02-12)

Definiert in Zeile 12532 der Datei tcpdf.php.

Benutzt _getobj(), _newobj() und _out().

Wird benutzt von _putresources().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putocg ( )
protected

Put pdf layers.

Seit
3.0.000 (2008-03-27)

Definiert in Zeile 13655 der Datei tcpdf.php.

Benutzt _newobj() und _out().

Wird benutzt von _putresources().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putpages ( )
protected

Output pages (and replace page number aliases).

Definiert in Zeile 7881 der Datei tcpdf.php.

Benutzt $compress, $k, $n, $numpages, $pagelen, _getannotsrefs(), _getobj(), _getrawstream(), _newobj(), _out(), TCPDF_STATIC\formatPageNumber(), getAllInternalPageNumberAliases(), GetNumChars(), getPageBuffer(), TCPDF_STATIC\replacePageNumAliases(), replaceRightShiftPageNumAliases() und TCPDF_FONTS\UTF8ToUTF16BE().

Wird benutzt von _enddoc().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putresourcedict ( )
protected

Output Resources Dictionary.

Definiert in Zeile 9332 der Datei tcpdf.php.

Benutzt $k, _getobj(), _getxobjectdict(), _out() und getFontBuffer().

Wird benutzt von _putresources().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putresources ( )
protected

Output Resources.

Definiert in Zeile 9396 der Datei tcpdf.php.

Benutzt _putannotsobjs(), _putbookmarks(), _putdests(), _putEmbeddedFiles(), _putencryption(), _putextgstates(), _putfonts(), _putimages(), _putjavascript(), _putocg(), _putresourcedict(), _putshaders(), _putspotcolors() und _putxobjects().

Wird benutzt von _enddoc().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putshaders ( )
protected

Output gradient shaders.

Autor
Nicola Asuni
Seit
3.1.000 (2008-06-09)

Definiert in Zeile 14534 der Datei tcpdf.php.

Benutzt $n, _getrawstream(), _newobj() und _out().

Wird benutzt von _putresources().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putsignature ( )
protected

Add certification signature (DocMDP or UR3) You can set only one signature type

Autor
Nicola Asuni
Seit
4.6.008 (2009-05-07)

Definiert in Zeile 13299 der Datei tcpdf.php.

Benutzt _getobj(), _out() und TCPDF_STATIC\empty_string().

Wird benutzt von _enddoc().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putspotcolors ( )
protected

Output Spot Colors Resources.

Seit
4.0.024 (2008-09-12)

Definiert in Zeile 9300 der Datei tcpdf.php.

Benutzt $n, _newobj() und _out().

Wird benutzt von _putresources().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putstream (   $s,
  $n = 0 
)
protected

Output a stream (DEPRECATED).

Parameter
$s(string) string to output.
$n(int) object reference for encryption mode
Veraltet:

Definiert in Zeile 10281 der Datei tcpdf.php.

Benutzt $n, _getstream() und _out().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

_puttruetypeunicode (   $font)
protected

Adds unicode fonts.
Based on PDF Reference 1.3 (section 5)

Parameter
$font(array) font data
Autor
Nicola Asuni
Seit
1.52.0.TC005 (2005-01-05)

Definiert in Zeile 8914 der Datei tcpdf.php.

Benutzt $compress, TCPDF_FONT_DATA\$uni_identity_h, _getobj(), _getrawstream(), _newobj(), _out(), TCPDF_STATIC\empty_string(), Error() und TCPDF_FONTS\getFontFullPath().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

_putviewerpreferences ( )
protected

Output viewer preferences.

Rückgabe
string for viewer preferences
Autor
Nicola asuni
Seit
3.1.000 (2008-06-09)

Definiert in Zeile 9801 der Datei tcpdf.php.

Benutzt $k, $viewer_preferences und TCPDF_STATIC\empty_string().

Wird benutzt von _putcatalog().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putXMP ( )
protected

Put XMP data object and return ID.

Rückgabe
(int) The object ID.
Seit
5.9.121 (2011-09-28)

Definiert in Zeile 9480 der Datei tcpdf.php.

Benutzt $custom_xmp, $encrypted, $isunicode, TCPDF_STATIC\_escapeXML(), _newobj(), _out(), TCPDF_STATIC\getFormattedDate() und TCPDF_STATIC\getTCPDFProducer().

Wird benutzt von _putcatalog().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_putxobjects ( )
protected

Output Form XObjects Templates.

Autor
Nicola Asuni
Seit
5.8.017 (2010-08-24)
Siehe auch
startTemplate(), endTemplate(), printTemplate()

Definiert in Zeile 9197 der Datei tcpdf.php.

Benutzt $k, _getobj(), _getrawstream() und _out().

Wird benutzt von _putresources().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_textstring (   $s,
  $n = 0 
)
protected

Format a text string for meta information

Parameter
$s(string) string to escape.
$n(int) object ID
Rückgabe
string escaped string.

Definiert in Zeile 10219 der Datei tcpdf.php.

Benutzt $n, _datastring() und TCPDF_FONTS\UTF8ToUTF16BE().

Wird benutzt von _putannotsobjs() und Button().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_UEvalue ( )
protected

Compute UE value (used for encryption)

Rückgabe
string UE value
Seit
5.9.006 (2010-10-19)
Autor
Nicola Asuni

Definiert in Zeile 10663 der Datei tcpdf.php.

Wird benutzt von _generateencryptionkey().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

_Uvalue ( )
protected

Compute U value (used for encryption)

Rückgabe
string U value
Seit
2.0.000 (2008-01-02)
Autor
Nicola Asuni

Definiert in Zeile 10630 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\$enc_padding, TCPDF_STATIC\_md5_16(), TCPDF_STATIC\_RC4() und TCPDF_STATIC\getRandomSeed().

Wird benutzt von _generateencryptionkey().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Rückgabe
boolean
Seit
1.4
Siehe auch
SetAutoPageBreak()

Definiert in Zeile 4920 der Datei tcpdf.php.

Benutzt $AutoPageBreak, AddPage() und selectColumn().

Wird benutzt von checkPageBreak() und Write().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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)

Parameter
$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.
Autor
Nicola Asuni
Seit
5.9.101 (2011-07-06)

Definiert in Zeile 13473 der Datei tcpdf.php.

Benutzt $h, $n, $page, $w, $x, $y und getSignatureAppearanceArray().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

addExtGState (   $parms)
protected

Add transparency parameters to the current extgstate

Parameter
$parms(array) parameters
Rückgabe
the number of extgstates
Seit
3.0.000 (2008-03-27)

Definiert in Zeile 13754 der Datei tcpdf.php.

Benutzt $n und $xobjid.

Wird benutzt von setAlpha() und setOverprint().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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.
Rückgabe
array containing the font data, or false in case of error.
Parameter
$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.
Seit
1.5
Siehe auch
SetFont(), setFontSubsetting()

Definiert in Zeile 4190 der Datei tcpdf.php.

Benutzt $font_subsetting, $FontFamily, $numfonts, $xobjid, TCPDF_STATIC\empty_string(), Error(), getFontBuffer(), TCPDF_FONTS\getFontFullPath(), setFontBuffer() und setFontSubBuffer().

Wird benutzt von getFontAscent(), getFontDescent(), isCharDefined(), RadioButton(), replaceMissingChars() und SetFont().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

addHtmlLink (   $url,
  $name,
  $fill = false,
  $firstline = false,
  $color = '',
  $style = -1,
  $firstblock = false 
)

Output anchor link.

Parameter
$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.
Rückgabe
the number of cells used or the remaining text if $firstline = true;

Definiert in Zeile 10391 der Datei tcpdf.php.

Benutzt $fgcolor, $FontStyle, $page, AddLink(), SetFont(), SetLink(), SetTextColorArray() und Write().

Wird benutzt von writeHTML().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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).
Autor
Nicola Asuni
Seit
5.0.001 (2010-05-06)
Siehe auch
addTOCPage(), endTOCPage(), addTOC()

Definiert in Zeile 21462 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\empty_string(), TCPDF_STATIC\formatTOCPageNumber() und TCPDF_FONTS\UTF8ToUTF16BE().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

addHTMLVertSpace (   $hbz = 0,
  $hb = 0,
  $cell = false,
  $firsttag = false,
  $lasttag = false 
)
protected

Add vertical spaces if needed.

Parameter
$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.

Definiert in Zeile 19784 der Datei tcpdf.php.

Wird benutzt von openHTMLTagHandler().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

addJavascriptObject (   $script,
  $onload = false 
)

Adds a javascript object and return object ID

Parameter
$script(string) Javascript code
$onload(boolean) if true executes this object when opening the document
Rückgabe
int internal object ID
Autor
Nicola Asuni
Seit
4.8.000 (2009-09-07)

Definiert in Zeile 12516 der Datei tcpdf.php.

Benutzt $n.

Wird benutzt von Button().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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().

Seit
1.5
Siehe auch
Cell(), Write(), Image(), Link(), SetLink()

Definiert in Zeile 4696 der Datei tcpdf.php.

Benutzt $n.

Wird benutzt von addHtmlLink() und openHTMLTagHandler().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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).
Seit
1.0
Siehe auch
startPage(), endPage(), addTOCPage(), endTOCPage(), getPageSizeFromFormat(), setPageFormat()

Definiert in Zeile 3089 der Datei tcpdf.php.

Benutzt $lMargin, $rMargin, $tocpage, endPage() und startPage().

Wird benutzt von AcceptPageBreak(), addTOCPage(), checkPageBreak() und Close().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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).
Autor
Nicola Asuni
Seit
5.9.003 (2010-10-13)
Siehe auch
setPageRegions(), getPageRegions()

Definiert in Zeile 22495 der Datei tcpdf.php.

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.

Parameter
$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.
Seit
4.0.024 (2008-09-12)
Siehe auch
SetDrawSpotColor(), SetFillSpotColor(), SetTextSpotColor()

Definiert in Zeile 3703 der Datei tcpdf.php.

Benutzt $k und $y.

Wird benutzt von ImageEps() und setColor().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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).
Autor
Nicola Asuni
Seit
4.5.000 (2009-01-02)
Siehe auch
addTOCPage(), endTOCPage(), addHTMLTOC()

Definiert in Zeile 21252 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\empty_string(), TCPDF_STATIC\formatTOCPageNumber() und TCPDF_FONTS\UTF8ToUTF16BE().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

addTOCPage (   $orientation = '',
  $format = '',
  $keepmargins = false 
)

Adds a new TOC (Table Of Content) page to the document.

Parameter
$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
Seit
5.0.001 (2010-05-06)
Siehe auch
AddPage(), startPage(), endPage(), endTOCPage()

Definiert in Zeile 3064 der Datei tcpdf.php.

Benutzt AddPage().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

addTTFfont (   $fontfile,
  $fonttype = '',
  $enc = '',
  $flags = 32,
  $outpath = '',
  $platid = 3,
  $encid = 1,
  $addcbbox = false 
)

Convert and add the selected TrueType or Type1 font to the fonts folder (that must be writeable).

Parameter
$fontfile(string) Font file (full path).
$fonttype(string) Font type. Leave empty for autodetect mode. Valid values are: TrueTypeUnicode, TrueType, Type1, CID0JP = CID-0 Japanese, CID0KR = CID-0 Korean, CID0CS = CID-0 Chinese Simplified, CID0CT = CID-0 Chinese Traditional.
$enc(string) Name of the encoding table to use. Leave empty for default mode. Omit this parameter for TrueType Unicode and symbolic fonts like Symbol or ZapfDingBats.
$flags(int) Unsigned 32-bit integer containing flags specifying various characteristics of the font (PDF32000:2008 - 9.8.2 Font Descriptor Flags): +1 for fixed font; +4 for symbol or +32 for non-symbol; +64 for italic. Fixed and Italic mode are generally autodetected so you have to set it to 32 = non-symbolic font (default) or 4 = symbolic font.
$outpath(string) Output path for generated font files (must be writeable by the web server). Leave empty for default font folder.
$platid(int) Platform ID for CMAP table to extract (when building a Unicode font for Windows this value should be 3, for Macintosh should be 1).
$encid(int) Encoding ID for CMAP table to extract (when building a Unicode font for Windows this value should be 1, for Macintosh should be 0). When Platform ID is 3, legal values for Encoding ID are: 0=Symbol, 1=Unicode, 2=ShiftJIS, 3=PRC, 4=Big5, 5=Wansung, 6=Johab, 7=Reserved, 8=Reserved, 9=Reserved, 10=UCS-4.
$addcbbox(boolean) If true includes the character bounding box information on the php font file.
Rückgabe
(string) TCPDF font name.
Autor
Nicola Asuni
Seit
5.9.123 (2010-09-30)
Veraltet:

Definiert in Zeile 4173 der Datei tcpdf.php.

Benutzt TCPDF_FONTS\addTTFfont().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

adjustCellPadding (   $brd = 0)
protected

Adjust the internal Cell padding array to take account of the line width.

Parameter
$brd(mixed) Indicates if borders must be drawn around the cell. The value can be a number:
  • 0: no border (default)
  • 1: frame
or a string containing some or all of the following characters (in any order):
  • L: left
  • T: top
  • R: right
  • B: bottom
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)))
Rückgabe
array of adjustments
Seit
5.9.000 (2010-10-03)

Definiert in Zeile 2702 der Datei tcpdf.php.

Benutzt $cell_padding und $LineWidth.

Wird benutzt von Cell(), getCellCode(), getNumLines(), getStringHeight() und MultiCell().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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 !!!!

Parameter
$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
Seit
4.0.018 (2008-08-06)

Definiert in Zeile 4752 der Datei tcpdf.php.

Benutzt $h, $k, $page, $w, $x, $xobjid, $y, checkPageRegions(), TCPDF_STATIC\empty_string(), Image() und TCPDF_STATIC\isValidURL().

Wird benutzt von Button(), Link(), RadioButton() und TextField().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

Arrow (   $x0,
  $y0,
  $x1,
  $y1,
  $head_style = 0,
  $arm_size = 5,
  $arm_angle = 15 
)

Draws a grahic arrow.

Parameter
$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
Autor
Piotr Galecki, Nicola Asuni, Andy Meier
Seit
4.6.018 (2009-07-10)

Definiert in Zeile 12163 der Datei tcpdf.php.

Benutzt $LineWidth, Line() und Polygon().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Bookmark (   $txt,
  $level = 0,
  $y = -1,
  $page = '',
  $style = '',
  $color = array(0,0,0),
  $x = -1,
  $link = '' 
)

Adds a bookmark.

Parameter
$txt(string) Bookmark description.
$level(int) Bookmark level (minimum value is 0).
$y(float) Y position in user units of the bookmark on the selected page (default = -1 = current position; 0 = page start;).
$page(int) Target page number (leave empty for current page).
$style(string) Font style: B = Bold, I = Italic, BI = Bold + Italic.
$color(array) RGB color array (values from 0 to 255).
$x(float) X position in user units of the bookmark on the selected page (default = -1 = current position;).
$link(mixed) URL, or numerical link ID, or named destination (# character followed by the destination name), or embedded file (* character followed by the file name).
Seit
2.1.002 (2008-02-12)

Definiert in Zeile 12318 der Datei tcpdf.php.

Benutzt $h, $page, $w, $x, $y, GetX(), GetY() und PageNo().

Wird benutzt von setBookmark().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

Button (   $name,
  $w,
  $h,
  $caption,
  $action,
  $prop = array(),
  $opt = array(),
  $x = '',
  $y = '',
  $js = false 
)

Creates a button field

Parameter
$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).
Autor
Nicola Asuni
Seit
4.8.000 (2009-09-07)

Definiert in Zeile 13132 der Datei tcpdf.php.

Benutzt $h, $k, $n, $w, $x, $y, _addfield(), _textstring(), addJavascriptObject(), Annotation(), Cell(), checkPageRegions(), endTemplate(), TCPDF_STATIC\getAnnotOptFromJSProp(), getFormDefaultProp(), SetFillColor() und startTemplate().

Wird benutzt von openHTMLTagHandler().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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
or a string containing some or all of the following characters (in any order):
  • L: left
  • T: top
  • R: right
  • B: bottom
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)))
$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
Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
$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
General font stretching and scaling values will be preserved when possible.
$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
Seit
1.0
Siehe auch
SetFont(), SetDrawColor(), SetFillColor(), SetTextColor(), SetLineWidth(), AddLink(), Ln(), MultiCell(), Write(), SetAutoPageBreak()

Definiert in Zeile 5001 der Datei tcpdf.php.

Benutzt $alpha, $bgcolor, $cell_margin, $cell_padding, $fgcolor, $h, $strokecolor, $w, $x, $y, _out(), adjustCellPadding(), checkPageBreak(), getCellCode(), getCellHeight(), setAlpha(), SetDrawColorArray(), SetFillColorArray() und SetTextColorArray().

Wird benutzt von Button(), Close(), Footer(), Header(), Image(), ImageEps(), Text(), Write() und write1DBarcode().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

CheckBox (   $name,
  $w,
  $checked = false,
  $prop = array(),
  $opt = array(),
  $onvalue = 'Yes',
  $x = '',
  $y = '',
  $js = false 
)

Creates a CheckBox field

Parameter
$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).
Autor
Nicola Asuni
Seit
4.8.000 (2009-09-07)

Definiert in Zeile 13052 der Datei tcpdf.php.

Wird benutzt von openHTMLTagHandler().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

checkPageBreak (   $h = 0,
  $y = '',
  $addpage = true 
)
protected

Add page if needed.

Parameter
$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
Rückgabe
boolean true in case of page break, false otherwise.
Seit
3.2.000 (2008-07-01)

Definiert in Zeile 4947 der Datei tcpdf.php.

Benutzt $h, $page, $tMargin, $x, $y, AcceptPageBreak(), AddPage(), TCPDF_STATIC\empty_string() und inPageBody().

Wird benutzt von Cell(), fitBlock(), MultiCell(), openHTMLTagHandler() und writeHTML().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

checkPageRegions (   $h,
  $x,
  $y 
)
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.

Parameter
$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
Rückgabe
array($x, $y)
Autor
Nicola Asuni
Seit
5.9.003 (2010-10-13)

Definiert in Zeile 22532 der Datei tcpdf.php.

Wird benutzt von Annotation(), Button(), getCellCode(), getRemainingWidth(), Image(), ImageEps(), ListBox(), MultiCell(), RadioButton(), TextField(), Write(), write1DBarcode() und write2DBarcode().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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.
Seit
2.1.000 (2008-01-08)

Definiert in Zeile 11846 der Datei tcpdf.php.

Benutzt Ellipse().

Wird benutzt von registrationMark(), registrationMarkCMYK(), RegularPolygon() und StarPolygon().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

Clip (   $x,
  $y,
  $w,
  $h 
)
protected

Set a rectangular clipping area.

Parameter
$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.
Autor
Andreas W, Nicola Asuni
Seit
3.1.000 (2008-06-09)

Definiert in Zeile 14400 der Datei tcpdf.php.

Benutzt $h, $w, $x, $y und _out().

Wird benutzt von CoonsPatchMesh(), LinearGradient() und RadialGradient().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Seit
1.0
Siehe auch
Open(), Output()

Definiert in Zeile 2938 der Datei tcpdf.php.

Benutzt $k, _destroy(), _enddoc(), _outRestoreGraphicsState(), _outSaveGraphicsState(), AddPage(), Cell(), endLayer(), endPage(), getGraphicVars(), PDF_FONT_NAME_MAIN, SetAutoPageBreak(), setEqualColumns(), SetFont(), setGraphicVars() und setTextRenderingMode().

Wird benutzt von getPDFData() und Output().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

closeHTMLTagHandler (   $dom,
  $key,
  $cell,
  $maxbottomliney = 0 
)
protected

Process closing tags.

Parameter
$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
Rückgabe
$dom array

Definiert in Zeile 19249 der Datei tcpdf.php.

Wird benutzt von writeHTML().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

colorRegistrationBar (   $x,
  $y,
  $w,
  $h,
  $transition = true,
  $vertical = false,
  $colors = 'A,
,
,
,
,
,
,
K'   
)

Paints color transition registration bars

Parameter
$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.
Autor
Nicola Asuni
Seit
4.9.000 (2010-03-26)

Definiert in Zeile 13985 der Datei tcpdf.php.

Benutzt $h, $spot_colors, $w, $x, $y, TCPDF_COLORS\getSpotColor(), LinearGradient(), Rect() und SetFillColorArray().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

ComboBox (   $name,
  $w,
  $h,
  $values,
  $prop = array(),
  $opt = array(),
  $x = '',
  $y = '',
  $js = false 
)

Creates a Combo-box field

Parameter
$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).
Autor
Nicola Asuni
Seit
4.8.000 (2009-09-07)

Definiert in Zeile 12965 der Datei tcpdf.php.

commitTransaction ( )

Delete the copy of the current TCPDF object used for undo operation.

Seit
4.5.029 (2009-03-19)

Definiert in Zeile 21612 der Datei tcpdf.php.

convertSVGtMatrix (   $tm)
protected

Convert SVG transformation matrix to PDF.

Parameter
$tm(array) original SVG transformation matrix
Rückgabe
array transformation matrix
Seit
5.0.000 (2010-05-02)

Definiert in Zeile 22956 der Datei tcpdf.php.

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.

Parameter
$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.
Autor
Andreas W, Nicola Asuni
Seit
3.1.000 (2008-06-09)

Definiert in Zeile 14308 der Datei tcpdf.php.

Benutzt $h, $n, $w, $x, $xobjid, $y, _out(), _outRestoreGraphicsState() und Clip().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

copyPage (   $page = 0)

Clone the specified page to a new page.

Parameter
$page(int) number of page to copy (0 = current page)
Rückgabe
true in case of success, false in case of error.
Seit
4.9.015 (2010-04-20)

Definiert in Zeile 21175 der Datei tcpdf.php.

cropMark (   $x,
  $y,
  $w,
  $h,
  $type = 'T,
,
,
L'  ,
  $color = array(100,100,100,100,'All') 
)

Paints crop marks.

Parameter
$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).
Autor
Nicola Asuni
Seit
4.9.000 (2010-03-26)

Definiert in Zeile 14125 der Datei tcpdf.php.

Benutzt $h, $w, $x, $y, Line() und SetLineStyle().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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.

Parameter
$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).
Siehe auch
SetLineStyle()
Seit
2.1.000 (2008-01-08)

Definiert in Zeile 11604 der Datei tcpdf.php.

Benutzt _out(), _outCurve(), _outPoint(), TCPDF_STATIC\getPathPaintOperator(), SetFillColorArray() und SetLineStyle().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

deletePage (   $page)

Remove the specified page.

Parameter
$page(int) page to remove
Rückgabe
true in case of success, false in case of error.
Seit
4.6.004 (2009-04-23)

Definiert in Zeile 20991 der Datei tcpdf.php.

drawHTMLTagBorder (   $tag,
  $xmax 
)
protected

Draw an HTML block border and fill

Parameter
$tag(array) array of tag properties.
$xmax(int) end X coordinate for border.
Seit
5.7.000 (2010-08-03)

Definiert in Zeile 19826 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\empty_string() und TCPDF_STATIC\getBorderMode().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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.

Parameter
$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.
Autor
Nicola Asuni
Seit
2.1.000 (2008-01-08)

Definiert in Zeile 11674 der Datei tcpdf.php.

Benutzt _out(), _outellipticalarc(), TCPDF_STATIC\empty_string(), TCPDF_STATIC\getPathPaintOperator(), SetFillColorArray() und SetLineStyle().

Wird benutzt von Circle().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

endLayer ( )

End the current PDF layer.

Seit
5.9.102 (2011-07-13)

Definiert in Zeile 13702 der Datei tcpdf.php.

Benutzt _out().

Wird benutzt von Close() und setVisibility().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

endPage (   $tocpage = false)

Terminate the current page

Parameter
$tocpage(boolean) if true set the tocpage state to false (end the page used to display Table Of Content).
Seit
4.2.010 (2008-11-14)
Siehe auch
AddPage(), startPage(), addTOCPage(), endTOCPage()

Definiert in Zeile 3113 der Datei tcpdf.php.

Benutzt $page, $tocpage, _endpage() und setFooter().

Wird benutzt von AddPage(), Close() und endTOCPage().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

endSVGElementHandler (   $parser,
  $name 
)
protected

Sets the closing SVG element handler function for the XML parser.

Parameter
$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.
Autor
Nicola Asuni
Seit
5.0.000 (2010-05-02)

Definiert in Zeile 24206 der Datei tcpdf.php.

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.

Rückgabe
int the XObject Template ID in case of success or false in case of error.
Autor
Nicola Asuni
Seit
5.8.017 (2010-08-24)
Siehe auch
startTemplate(), printTemplate()

Definiert in Zeile 22253 der Datei tcpdf.php.

Wird benutzt von Button(), Header() und TextField().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

endTOCPage ( )

Terminate the current TOC (Table Of Content) page

Seit
5.0.001 (2010-05-06)
Siehe auch
AddPage(), startPage(), endPage(), addTOCPage()

Definiert in Zeile 3074 der Datei tcpdf.php.

Benutzt endPage().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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.

Parameter
$msg(string) The error message
Seit
1.0

Definiert in Zeile 2908 der Datei tcpdf.php.

Benutzt _destroy() und K_TCPDF_THROW_EXCEPTION_ERROR.

Wird benutzt von _dochecks(), _generateencryptionkey(), _putfonts(), _puttruetypeunicode(), AddFont(), Image(), ImageEps(), ImagePngAlpha(), TCPDF_IMPORT\importPDF(), openHTMLTagHandler(), Output(), Scale(), SetDisplayMode(), setPage(), setPageUnit(), SetProtection(), setSignature(), setSpotColor(), setVisibility(), Skew(), write1DBarcode(), write2DBarcode() und writeHTML().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

fitBlock (   $w,
  $h,
  $x,
  $y,
  $fitonpage = false 
)
protected

Set the block dimensions accounting for page breaks and page/column fitting

Parameter
$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.
Rückgabe
array($w, $h, $x, $y)
Seit
5.5.009 (2010-07-05)

Definiert in Zeile 6706 der Datei tcpdf.php.

Benutzt $h, $lMargin, $PageBreakTrigger, $rMargin, $tMargin, $w, $x, $y und checkPageBreak().

Wird benutzt von Image(), ImageEps(), write1DBarcode() und write2DBarcode().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

fixHTMLCode (   $html,
  $default_css = '',
  $tagvs = '',
  $tidy_options = '' 
)

Cleanup HTML code (requires HTML Tidy library).

Parameter
$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
Rückgabe
string XHTML code cleaned up
Autor
Nicola Asuni
Seit
5.9.017 (2010-11-16)
Siehe auch
setHtmlVSpace()

Definiert in Zeile 15789 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\fixHTMLCode().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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.

Definiert in Zeile 3456 der Datei tcpdf.php.

Benutzt $barcode, $k, $y, Cell(), getAliasNbPages(), getAliasRightShift(), getBarcode(), getPageGroupAlias(), getRTL(), Ln(), SetLineStyle(), SetTextColorArray(), SetX(), SetY() und write1DBarcode().

Wird benutzt von setFooter().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getAbsFontMeasure (   $s)

Convert a relative font measure into absolute value.

Parameter
$s(int) Font measure.
Rückgabe
float Absolute measure.
Seit
5.9.186 (2012-09-13)

Definiert in Zeile 4553 der Datei tcpdf.php.

Wird benutzt von getFontBBox(), getRawCharWidth() und RadioButton().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

GetAbsX ( )

Returns the absolute X value of current position.

Rückgabe
float
Seit
1.2
Siehe auch
SetX(), GetY(), SetY()

Definiert in Zeile 7388 der Datei tcpdf.php.

Benutzt $x.

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.

Rückgabe
string
Seit
4.0.018 (2008-08-08)

Definiert in Zeile 13568 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\$alias_tot_pages und isUnicodeFont().

Wird benutzt von Footer().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Rückgabe
string
Seit
4.5.000 (2009-01-02)

Definiert in Zeile 13583 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\$alias_num_page und isUnicodeFont().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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.

Rückgabe
string
Seit
5.9.099 (2011-06-27)

Definiert in Zeile 13542 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\$alias_num_page, TCPDF_STATIC\$alias_right_shift, TCPDF_STATIC\$alias_tot_pages, GetNumChars(), GetStringWidth() und isUnicodeFont().

Wird benutzt von Footer().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getAllInternalPageNumberAliases ( )
protected

Return an array containing all internal page aliases.

Rückgabe
array of page number aliases

Definiert in Zeile 7815 der Datei tcpdf.php.

Benutzt 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 und getInternalPageNumberAliases().

Wird benutzt von _putpages().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getAllSpotColors ( )

Returns the array of spot colors.

Rückgabe
(array) Spot colors array.
Seit
6.0.038 (2013-09-30)

Definiert in Zeile 3686 der Datei tcpdf.php.

Benutzt $spot_colors.

getAlpha ( )

Get the alpha mode array (CA, ca, BM, AIS). (Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).

Rückgabe
array.
Seit
5.9.152 (2012-03-23)

Definiert in Zeile 13898 der Datei tcpdf.php.

Benutzt $alpha.

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.

Parameter
$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
or any combination. The default value is regular.
$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.
Rückgabe
mixed int total string length or array of characted widths
Autor
Nicola Asuni
Seit
2.4.000 (2008-03-06)

Definiert in Zeile 4035 der Datei tcpdf.php.

Benutzt $FontFamily, $FontSizePt, $FontStyle, $w, TCPDF_STATIC\empty_string(), GetCharWidth(), isUnicodeFont(), SetFont() und TCPDF_FONTS\UTF8ArrToLatin1Arr().

Wird benutzt von getCellCode(), getNumLines(), GetStringWidth() und Write().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getAutoPageBreak ( )

Return the auto-page-break mode (true or false).

Rückgabe
boolean auto-page-break mode
Seit
5.9.088

Definiert in Zeile 2789 der Datei tcpdf.php.

Benutzt $AutoPageBreak.

getBarcode ( )

Get current barcode.

Rückgabe
string
Seit
4.0.012 (2008-07-24)

Definiert in Zeile 15120 der Datei tcpdf.php.

Benutzt $barcode.

Wird benutzt von Footer().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getBorderStartPosition ( )
protected

Return the starting coordinates to draw an html border

Rückgabe
array containing top-left border coordinates
Seit
5.7.000 (2010-08-03)

Definiert in Zeile 19810 der Datei tcpdf.php.

getBreakMargin (   $pagenum = '')

Returns the page break margin.

Parameter
$pagenum(int) page number (empty = current page)
Rückgabe
int page break margin.
Autor
Nicola Asuni
Seit
1.5.2
Siehe auch
getPageDimensions()

Definiert in Zeile 2520 der Datei tcpdf.php.

Benutzt $bMargin.

getBuffer ( )
protected

Get buffer content.

Rückgabe
string buffer content
Seit
4.5.000 (2009-01-02)

Definiert in Zeile 20642 der Datei tcpdf.php.

Wird benutzt von Output().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getCellBorder (   $x,
  $y,
  $w,
  $h,
  $brd 
)
protected

Returns the code to draw the cell border

Parameter
$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
or a string containing some or all of the following characters (in any order):
  • L: left
  • T: top
  • R: right
  • B: bottom
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)))
Rückgabe
string containing cell border code
Siehe auch
SetLineStyle()
Seit
5.7.000 (2010-08-02)

Definiert in Zeile 5561 der Datei tcpdf.php.

Benutzt $h, $k, $LineWidth, $w, $x, $y und SetLineStyle().

Wird benutzt von getCellCode().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getCellCode (   $w,
  $h = 0,
  $txt = '',
  $border = 0,
  $ln = 0,
  $align = '',
  $fill = false,
  $link = '',
  $stretch = 0,
  $ignore_min_height = false,
  $calign = 'T',
  $valign = 'M' 
)
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.

Parameter
$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
or a string containing some or all of the following characters (in any order):
  • L: left
  • T: top
  • R: right
  • B: bottom
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)))
$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
Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
$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
General font stretching and scaling values will be preserved when possible.
$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
Rückgabe
string containing cell code
Seit
1.0
Siehe auch
Cell()

Definiert in Zeile 5070 der Datei tcpdf.php.

Benutzt $cell_margin, $cell_padding, $font_spacing, $font_stretching, $FontAscent, $FontDescent, $FontSize, $h, $k, $lMargin, $rMargin, $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() und TCPDF_FONTS\UTF8ToLatin1().

Wird benutzt von Cell() und MultiCell().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getCellHeight (   $fontsize,
  $padding = TRUE 
)

Return the cell height

Parameter
$fontsize(int) Font size in internal units
$padding(boolean) If true add cell padding

Definiert in Zeile 2414 der Datei tcpdf.php.

Benutzt $cell_height_ratio.

Wird benutzt von Cell(), getCellCode(), getStringHeight(), Header(), openHTMLTagHandler(), resetLastH(), Write(), write1DBarcode() und writeHTML().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getCellHeightRatio ( )

return the height of cell repect font height.

Seit
4.0.012 (2008-07-24)

Definiert in Zeile 13940 der Datei tcpdf.php.

Benutzt $cell_height_ratio.

getCellMargins ( )

Get the internal Cell margin array.

Rückgabe
array of margin values
Seit
5.9.000 (2010-10-03)
Siehe auch
setCellMargins()

Definiert in Zeile 2691 der Datei tcpdf.php.

Benutzt $cell_margin.

getCellPaddings ( )

Get the internal Cell padding array.

Rückgabe
array of padding values
Seit
5.9.000 (2010-10-03)
Siehe auch
setCellPaddings(), SetCellPadding()

Definiert in Zeile 2655 der Datei tcpdf.php.

Benutzt $cell_padding.

getCharBBox (   $char)

Returns the glyph bounding box of the specified character in the current font in user units.

Parameter
$char(int) Input character code.
Rückgabe
mixed array(xMin, yMin, xMax, yMax) or FALSE if not defined.
Seit
5.9.186 (2012-09-13)

Definiert in Zeile 4563 der Datei tcpdf.php.

GetCharWidth (   $char,
  $notlast = true 
)

Returns the length of the char in user unit for the current font considering current stretching and spacing (tracking).

Parameter
$char(int) The char code whose length is to be returned
$notlast(boolean) If false ignore the font-spacing.
Rückgabe
float char width
Autor
Nicola Asuni
Seit
2.4.000 (2008-03-06)

Definiert in Zeile 4074 der Datei tcpdf.php.

Benutzt $font_spacing und getRawCharWidth().

Wird benutzt von GetArrStringWidth() und Write().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getColumn ( )

Return the current column number

Rückgabe
int current column number
Seit
5.5.011 (2010-07-08)

Definiert in Zeile 21796 der Datei tcpdf.php.

getCSSBorderDashStyle (   $style)
protected

Returns the border dash style from CSS property

Parameter
$style(string) border style to convert
Rückgabe
int sash style (return -1 in case of none or hidden border)
Seit
5.7.000 (2010-08-02)

Definiert in Zeile 15820 der Datei tcpdf.php.

Wird benutzt von getCSSBorderStyle() und getHtmlDomArray().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getCSSBorderMargin (   $cssbspace,
  $width = 0 
)

Get the border-spacing from CSS attribute.

Parameter
$cssbspace(string) border-spacing CSS properties
$width(float) width of the containing element
Rückgabe
array of border spacings
Seit
5.9.010 (2010-10-27)

Definiert in Zeile 16015 der Datei tcpdf.php.

Benutzt $rMargin und getHTMLUnitToUnits().

Wird benutzt von getHtmlDomArray().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getCSSBorderStyle (   $cssborder)
protected

Returns the border style array from CSS border properties

Parameter
$cssborder(string) border properties
Rückgabe
array containing border properties
Seit
5.7.000 (2010-08-02)

Definiert in Zeile 15856 der Datei tcpdf.php.

Benutzt TCPDF_COLORS\convertHTMLColorToDec(), getCSSBorderDashStyle() und getCSSBorderWidth().

Wird benutzt von getHtmlDomArray().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getCSSBorderWidth (   $width)
protected

Returns the border width from CSS property

Parameter
$width(string) border width
Rückgabe
int with in user units
Seit
5.7.000 (2010-08-02)

Definiert in Zeile 15800 der Datei tcpdf.php.

Benutzt $k und getHTMLUnitToUnits().

Wird benutzt von getCSSBorderStyle() und getHtmlDomArray().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getCSSFontSpacing (   $spacing,
  $parent = 0 
)
protected

Returns the letter-spacing value from CSS value

Parameter
$spacing(string) letter-spacing value
$parent(float) font spacing (tracking) value of the parent element
Rückgabe
float quantity to increases or decreases the space between characters in a text.
Seit
5.9.000 (2010-10-02)

Definiert in Zeile 16049 der Datei tcpdf.php.

Benutzt getHTMLUnitToUnits().

Wird benutzt von getHtmlDomArray().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getCSSFontStretching (   $stretch,
  $parent = 100 
)
protected

Returns the percentage of font stretching from CSS value

Parameter
$stretch(string) stretch mode
$parent(float) stretch value of the parent element
Rückgabe
float font stretching percentage
Seit
5.9.000 (2010-10-02)

Definiert in Zeile 16080 der Datei tcpdf.php.

Benutzt getHTMLUnitToUnits().

Wird benutzt von getHtmlDomArray().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getCSSMargin (   $cssmargin,
  $width = 0 
)

Get the internal Cell margin from CSS attribute.

Parameter
$cssmargin(string) margin properties
$width(float) width of the containing element
Rückgabe
array of cell margins
Seit
5.9.000 (2010-10-04)

Definiert in Zeile 15961 der Datei tcpdf.php.

Benutzt $cell_margin, $rMargin und getHTMLUnitToUnits().

Wird benutzt von getHtmlDomArray().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getCSSPadding (   $csspadding,
  $width = 0 
)

Get the internal Cell padding from CSS attribute.

Parameter
$csspadding(string) padding properties
$width(float) width of the containing element
Rückgabe
array of cell paddings
Seit
5.9.000 (2010-10-04)

Definiert in Zeile 15907 der Datei tcpdf.php.

Benutzt $cell_padding, $rMargin und getHTMLUnitToUnits().

Wird benutzt von getHtmlDomArray().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getDestination ( )

Return the Named Destination array.

Rückgabe
(array) Named Destination array.
Autor
Nicola Asuni
Seit
5.9.097 (2011-06-23)

Definiert in Zeile 12265 der Datei tcpdf.php.

Benutzt $dests.

getDocCreationTimestamp ( )

Returns document creation timestamp in seconds.

Rückgabe
(int) Creation timestamp in seconds.
Seit
5.9.152 (2012-03-23)

Definiert in Zeile 10183 der Datei tcpdf.php.

Benutzt $doc_creation_timestamp.

getDocModificationTimestamp ( )

Returns document modification timestamp in seconds.

Rückgabe
(int) Modfication timestamp in seconds.
Seit
5.9.152 (2012-03-23)

Definiert in Zeile 10193 der Datei tcpdf.php.

Benutzt $doc_modification_timestamp.

getFontAscent (   $font,
  $style = '',
  $size = 0 
)

Return the font ascent value.

Parameter
$font(string) font name
$style(string) font style
$size(float) The size (in points)
Rückgabe
int font ascent
Autor
Nicola Asuni
Seit
4.9.003 (2010-03-30)

Definiert in Zeile 4601 der Datei tcpdf.php.

Benutzt AddFont() und getFontBuffer().

Wird benutzt von writeHTML().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getFontBBox ( )

Returns the bounding box of the current font in user units.

Rückgabe
array
Seit
5.9.152 (2012-03-23)

Definiert in Zeile 4514 der Datei tcpdf.php.

Benutzt $w und getAbsFontMeasure().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

getFontBuffer (   $font)
protected

Get font buffer content.

Parameter
$font(string) font key
Rückgabe
string font buffer content or false in case of error
Seit
4.5.000 (2009-01-02)

Definiert in Zeile 20809 der Datei tcpdf.php.

Wird benutzt von _putcatalog(), _putfonts(), _putresourcedict(), AddFont(), getFontAscent(), getFontDescent(), isCharDefined(), RadioButton(), replaceMissingChars() und SetFont().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getFontDescent (   $font,
  $style = '',
  $size = 0 
)

Return the font descent value

Parameter
$font(string) font name
$style(string) font style
$size(float) The size (in points)
Rückgabe
int font descent
Autor
Nicola Asuni
Seit
4.9.003 (2010-03-30)

Definiert in Zeile 4580 der Datei tcpdf.php.

Benutzt AddFont() und getFontBuffer().

Wird benutzt von writeHTML().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getFontFamily ( )

Returns the current font family name.

Rückgabe
string current font family name
Seit
4.3.008 (2008-12-05)

Definiert in Zeile 15763 der Datei tcpdf.php.

Benutzt $FontFamily.

getFontFamilyName (   $fontfamily)

Return normalized font name

Parameter
$fontfamily(string) property string containing font family names
Rückgabe
string normalized font name
Autor
Nicola Asuni
Seit
5.8.004 (2010-08-17)

Definiert in Zeile 22145 der Datei tcpdf.php.

Wird benutzt von getHtmlDomArray().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getFontSize ( )

Returns the current font size.

Rückgabe
current font size
Seit
3.2.000 (2008-06-23)

Definiert in Zeile 15743 der Datei tcpdf.php.

Benutzt $FontSize.

getFontSizePt ( )

Returns the current font size in points unit.

Rückgabe
current font size in points unit
Seit
3.2.000 (2008-06-23)

Definiert in Zeile 15753 der Datei tcpdf.php.

Benutzt $FontSizePt.

getFontsList ( )
protected

Fill the list of available fonts ($this->fontlist).

Seit
4.0.013 (2008-07-28)

Definiert in Zeile 4134 der Datei tcpdf.php.

Benutzt TCPDF_FONTS\_getfontpath().

Wird benutzt von __construct().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getFontSpacing ( )

Get the amount to increase or decrease the space between characters in a text.

Rückgabe
int font spacing (tracking) value
Autor
Nicola Asuni
Seit
5.9.000 (2010-09-29)

Definiert in Zeile 22448 der Datei tcpdf.php.

getFontStretching ( )

Get the percentage of character stretching.

Rückgabe
float stretching value
Autor
Nicola Asuni
Seit
5.9.000 (2010-09-29)

Definiert in Zeile 22426 der Datei tcpdf.php.

getFontStyle ( )

Returns the current font style.

Rückgabe
string current font style
Seit
4.3.008 (2008-12-05)

Definiert in Zeile 15773 der Datei tcpdf.php.

Benutzt $FontStyle.

getFontSubsetting ( )

Return the default option for font subsetting.

Rückgabe
boolean default font subsetting state.
Autor
Nicola Asuni
Seit
5.3.002 (2010-06-07)

Definiert in Zeile 22081 der Datei tcpdf.php.

getFooterFont ( )

Get Footer font.

Rückgabe
array() Array describing the basic font parameters: (family, style, size).
Seit
4.0.012 (2008-07-24)

Definiert in Zeile 10349 der Datei tcpdf.php.

Benutzt $footer_font.

getFooterMargin ( )

Returns footer margin in user units.

Rückgabe
float
Seit
4.0.012 (2008-07-24)

Definiert in Zeile 3318 der Datei tcpdf.php.

Benutzt $footer_margin.

getFormDefaultProp ( )

Return the default properties for form fields.

Rückgabe
array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
Autor
Nicola Asuni
Seit
4.8.000 (2009-09-06)

Definiert in Zeile 12637 der Datei tcpdf.php.

Benutzt $default_form_prop.

Wird benutzt von Button(), RadioButton() und TextField().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getGDgamma (   $img,
  $c 
)
protected

Get the GD-corrected PNG gamma value from alpha color

Parameter
$img(int) GD image Resource ID.
$c(int) alpha color
Seit
4.3.007 (2008-12-04)

Definiert in Zeile 7312 der Datei tcpdf.php.

Wird benutzt von ImagePngAlpha().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getGraphicVars ( )
protected

Returns current graphic variables as array.

Rückgabe
array of graphic variables
Seit
4.2.010 (2008-11-14)

Definiert in Zeile 20423 der Datei tcpdf.php.

Wird benutzt von __construct(), Close(), openHTMLTagHandler(), setFooter(), setTableHeader(), startPage(), write1DBarcode(), write2DBarcode() und writeHTML().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getGroupPageNo ( )

Return the current page in the group.

Rückgabe
current page in the group
Seit
3.0.000 (2008-03-27)

Definiert in Zeile 13626 der Datei tcpdf.php.

Benutzt $currpagegroup.

Wird benutzt von getGroupPageNoFormatted().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getGroupPageNoFormatted ( )

Returns the current group page number formatted as a string.

Seit
4.3.003 (2008-11-18)
Siehe auch
PaneNo(), formatPageNumber()

Definiert in Zeile 13636 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\formatPageNumber() und getGroupPageNo().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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
Rückgabe
array()
Seit
4.0.012 (2008-07-24)

Definiert in Zeile 3271 der Datei tcpdf.php.

Benutzt $header_line_color, $header_logo, $header_logo_width, $header_string, $header_text_color und $header_title.

Wird benutzt von Header().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getHeaderFont ( )

Get header font.

Rückgabe
array() Array describing the basic font parameters: (family, style, size).
Seit
4.0.012 (2008-07-24)

Definiert in Zeile 10329 der Datei tcpdf.php.

Benutzt $header_font.

Wird benutzt von Header().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getHeaderMargin ( )

Returns header margin in user units.

Rückgabe
float
Seit
4.0.012 (2008-07-24)

Definiert in Zeile 3298 der Datei tcpdf.php.

Benutzt $header_margin.

getHTMLFontUnits (   $val,
  $refsize = 12,
  $parent_size = 12,
  $defaultunit = 'pt' 
)

Convert HTML string containing font size value to points

Parameter
$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).
Rückgabe
float value in points

Definiert in Zeile 16152 der Datei tcpdf.php.

Benutzt TCPDF_FONTS\getFontRefSize() und getHTMLUnitToUnits().

Wird benutzt von getHtmlDomArray().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getHTMLUnitToUnits (   $htmlval,
  $refsize = 1,
  $defaultunit = 'px',
  $points = false 
)

Convert HTML string containing value and unit of measure to user's units or points.

Parameter
$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.
Rückgabe
float value in user's unit or point if $points=true
Seit
4.4.004 (2008-12-10)

Definiert in Zeile 20137 der Datei tcpdf.php.

Wird benutzt von getCSSBorderMargin(), getCSSBorderWidth(), getCSSFontSpacing(), getCSSFontStretching(), getCSSMargin(), getCSSPadding(), getHtmlDomArray(), getHTMLFontUnits(), Image(), openHTMLTagHandler() und writeHTML().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getImageBuffer (   $image)
protected

Get image buffer content.

Parameter
$image(string) image key
Rückgabe
string image buffer content or false in case of error
Seit
4.5.000 (2008-12-31)

Definiert in Zeile 20747 der Datei tcpdf.php.

Wird benutzt von _putannotsobjs(), _putimages() und Image().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getImageRBX ( )

Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image

Rückgabe
float

Definiert in Zeile 3344 der Datei tcpdf.php.

Benutzt $img_rb_x.

getImageRBY ( )

Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image

Rückgabe
float

Definiert in Zeile 3353 der Datei tcpdf.php.

Benutzt $img_rb_y.

Wird benutzt von Header().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getImageScale ( )

Returns the adjusting factor to convert pixels to user units.

Rückgabe
float adjusting factor to convert pixels to user units.
Autor
Nicola Asuni
Seit
1.5.2

Definiert in Zeile 2459 der Datei tcpdf.php.

Benutzt $imgscale.

getInternalPageNumberAliases (   $a = '')
protected

Return an array containing variations for the basic page number alias.

Parameter
$a(string) Base alias.
Rückgabe
array of page number aliases

Definiert in Zeile 7794 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\_escape(), TCPDF_FONTS\utf8StrRev() und TCPDF_FONTS\UTF8ToLatin1().

Wird benutzt von getAllInternalPageNumberAliases().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getLastH ( )

Get the last cell height.

Rückgabe
last cell height
Seit
4.0.017 (2008-08-05)

Definiert in Zeile 2437 der Datei tcpdf.php.

Benutzt $lasth.

GetLineWidth ( )

Returns the current the line width.

Rückgabe
int Line width
Seit
2.1.000 (2008-01-07)
Siehe auch
Line(), SetLineWidth()

Definiert in Zeile 11317 der Datei tcpdf.php.

Benutzt $LineWidth.

Wird benutzt von openHTMLTagHandler().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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
Rückgabe
array containing all margins measures
Seit
3.2.000 (2008-06-23)

Definiert in Zeile 15702 der Datei tcpdf.php.

getNumberOfColumns ( )

Return the current number of columns.

Rückgabe
int number of columns
Seit
5.8.018 (2010-08-25)

Definiert in Zeile 21806 der Datei tcpdf.php.

GetNumChars (   $s)

Returns the numbero of characters in a string.

Parameter
$s(string) The input string.
Rückgabe
int number of characters
Seit
2.0.0001 (2008-01-07)

Definiert in Zeile 4122 der Datei tcpdf.php.

Benutzt isUnicodeFont() und TCPDF_FONTS\UTF8StringToArray().

Wird benutzt von _putpages(), getAliasRightShift() und getCellCode().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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
or a string containing some or all of the following characters (in any order):
  • L: left
  • T: top
  • R: right
  • B: bottom
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)))
Rückgabe
float Return the minimal height needed for multicell method for printing the $txt param.
Autor
Alexander Escalona Fern, Nicola Asuni
Seit
4.5.011

Definiert in Zeile 6112 der Datei tcpdf.php.

Benutzt $cell_padding, $lasth, $lMargin, $w, $x, adjustCellPadding(), TCPDF_STATIC\empty_string(), GetArrStringWidth(), resetLastH(), TCPDF_FONTS\unichr(), TCPDF_FONTS\utf8Bidi() und TCPDF_FONTS\UTF8StringToArray().

Wird benutzt von getStringHeight().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getNumPages ( )

Get the total number of insered pages.

Rückgabe
int number of pages
Seit
2.1.000 (2008-01-07)
Siehe auch
setPage(), getPage(), lastpage()

Definiert in Zeile 3051 der Datei tcpdf.php.

Benutzt $numpages.

Wird benutzt von lastPage().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getOriginalMargins ( )

Returns an array containing original margins:

  • $ret['left'] = left margin
  • $ret['right'] = right margin
Rückgabe
array containing all margins measures
Seit
4.0.012 (2008-07-24)

Definiert in Zeile 15729 der Datei tcpdf.php.

getOverprint ( )

Get the overprint mode array (OP, op, OPM). (Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).

Rückgabe
array.
Seit
5.9.152 (2012-03-23)

Definiert in Zeile 13853 der Datei tcpdf.php.

Benutzt $overprint.

getPage ( )

Get current document page number.

Rückgabe
int page number
Seit
2.1.000 (2008-01-07)
Siehe auch
setPage(), lastpage(), getNumPages()

Definiert in Zeile 3040 der Datei tcpdf.php.

Benutzt $page.

getPageBuffer (   $page)
protected

Get page buffer content.

Parameter
$page(int) page number
Rückgabe
string page buffer content or false in case of error
Seit
4.5.000 (2008-12-31)

Definiert in Zeile 20685 der Datei tcpdf.php.

Wird benutzt von _out(), _putpages(), MultiCell() und writeHTML().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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
Parameter
$pagenum(int) page number (empty = current page)
Rückgabe
array of page dimensions.
Autor
Nicola Asuni
Seit
4.5.027 (2009-03-16)

Definiert in Zeile 2472 der Datei tcpdf.php.

Benutzt $page.

getPageGroupAlias ( )

Return the alias for the total number of pages in the current page group. If the current font is unicode type, the returned string is surrounded by additional curly braces. This alias will be replaced by the total number of pages in this group.

Rückgabe
alias of the current page group
Seit
3.0.000 (2008-03-27)

Definiert in Zeile 13598 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\$alias_group_tot_pages und isUnicodeFont().

Wird benutzt von Footer().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getPageHeight (   $pagenum = '')

Returns the page height in units.

Parameter
$pagenum(int) page number (empty = current page)
Rückgabe
int page height.
Autor
Nicola Asuni
Seit
1.5.2
Siehe auch
getPageDimensions()

Definiert in Zeile 2504 der Datei tcpdf.php.

Benutzt $h.

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).

Rückgabe
alias of the current page group
Seit
4.5.000 (2009-01-02)

Definiert in Zeile 13613 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\$alias_group_num_page und isUnicodeFont().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

getPageRegions ( )

Return an array of no-write page regions

Rückgabe
array of no-write page regions
Autor
Nicola Asuni
Seit
5.9.003 (2010-10-13)
Siehe auch
setPageRegions(), addPageRegion()

Definiert in Zeile 22460 der Datei tcpdf.php.

getPageWidth (   $pagenum = '')

Returns the page width in units.

Parameter
$pagenum(int) page number (empty = current page)
Rückgabe
int page width.
Autor
Nicola Asuni
Seit
1.5.2
Siehe auch
getPageDimensions()

Definiert in Zeile 2488 der Datei tcpdf.php.

Benutzt $w.

getPDFData ( )

Returns the PDF data.

Definiert in Zeile 10372 der Datei tcpdf.php.

Benutzt $buffer und Close().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

getRawCharWidth (   $char)

Returns the length of the char in user unit for the current font.

Parameter
$char(int) The char code whose length is to be returned
Rückgabe
float char width
Autor
Nicola Asuni
Seit
5.9.000 (2010-09-28)

Definiert in Zeile 4096 der Datei tcpdf.php.

Benutzt $w und getAbsFontMeasure().

Wird benutzt von GetCharWidth().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getRemainingWidth ( )
protected

Returns the remaining width between the current position and margins.

Rückgabe
int Return the remaining width

Definiert in Zeile 6686 der Datei tcpdf.php.

Benutzt checkPageRegions().

Wird benutzt von Write().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getRTL ( )

Return the RTL status

Rückgabe
boolean
Seit
4.0.012 (2008-07-24)

Definiert in Zeile 2351 der Datei tcpdf.php.

Benutzt $rtl.

Wird benutzt von Footer() und Header().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getScaleFactor ( )

Returns the scale factor (number of points in user unit).

Rückgabe
int scale factor.
Autor
Nicola Asuni
Seit
1.5.2

Definiert in Zeile 2534 der Datei tcpdf.php.

Benutzt $k.

getSignatureAppearanceArray (   $x = 0,
  $y = 0,
  $w = 0,
  $h = 0,
  $page = -1,
  $name = '' 
)
protected

Get the array that defines the signature appearance (page and rectangle coordinates).

Parameter
$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.
Rückgabe
(array) Array defining page and rectangle coordinates of signature appearance.
Autor
Nicola Asuni
Seit
5.9.101 (2011-07-06)

Definiert in Zeile 13491 der Datei tcpdf.php.

Benutzt $h, $k, $page, $w, $x und $y.

Wird benutzt von addEmptySignatureAppearance() und setSignatureAppearance().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getSpaceString ( )
protected

Returns the string used to find spaces

Rückgabe
string
Autor
Nicola Asuni
Seit
4.8.024 (2010-01-15)

Definiert in Zeile 16990 der Datei tcpdf.php.

Benutzt isUnicodeFont().

Wird benutzt von writeHTML().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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:

Vorbedingung
// 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();
Parameter
$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
or a string containing some or all of the following characters (in any order):
  • L: left
  • T: top
  • R: right
  • B: bottom
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)))
Rückgabe
float Return the minimal height needed for multicell method for printing the $txt param.
Autor
Nicola Asuni, Alexander Escalona Fern

Definiert in Zeile 6231 der Datei tcpdf.php.

Benutzt $cell_padding, $lasth, $w, adjustCellPadding(), getCellHeight() und getNumLines().

Wird benutzt von MultiCell().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

GetStringWidth (   $s,
  $fontname = '',
  $fontstyle = '',
  $fontsize = 0,
  $getarray = false 
)

Returns the length of a string in user unit. A font must be selected.

Parameter
$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
or any combination. The default value is regular.
$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.
Rückgabe
mixed int total string length or array of characted widths
Autor
Nicola Asuni
Seit
1.2

Definiert in Zeile 4019 der Datei tcpdf.php.

Benutzt GetArrStringWidth(), TCPDF_FONTS\utf8Bidi() und TCPDF_FONTS\UTF8StringToArray().

Wird benutzt von _dolinethrough(), _dooverline(), _dounderline(), getAliasRightShift(), getCellCode(), openHTMLTagHandler(), Write(), write1DBarcode() und writeHTML().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getTextShadow ( )

Return the text shadow parameters array.

Rückgabe
Array of parameters.
Seit
5.9.174 (2012-07-25)

Definiert in Zeile 21915 der Datei tcpdf.php.

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.

Rückgabe
float
Seit
1.2
Siehe auch
SetX(), GetY(), SetY()

Definiert in Zeile 7372 der Datei tcpdf.php.

Benutzt $x.

Wird benutzt von Bookmark(), MultiCell(), openHTMLTagHandler() und setDestination().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

GetY ( )

Returns the ordinate of the current position.

Rückgabe
float
Seit
1.0
Siehe auch
SetY(), GetX(), SetX()

Definiert in Zeile 7399 der Datei tcpdf.php.

Benutzt $y.

Wird benutzt von Bookmark(), MultiCell(), openHTMLTagHandler() und setDestination().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

Gradient (   $type,
  $coords,
  $stops,
  $background = array(),
  $antialias = false 
)

Output gradient.

Parameter
$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.
Autor
Nicola Asuni
Seit
3.1.000 (2008-06-09)

Definiert in Zeile 14427 der Datei tcpdf.php.

Benutzt $n, $xobjid, _out() und _outRestoreGraphicsState().

Wird benutzt von LinearGradient() und RadialGradient().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Definiert in Zeile 3379 der Datei tcpdf.php.

Benutzt $header_margin, $original_lMargin, $original_rMargin, $x, $y, Cell(), endTemplate(), getCellHeight(), getHeaderData(), getHeaderFont(), TCPDF_IMAGES\getImageFileType(), getImageRBY(), getRTL(), Image(), ImageEps(), ImageSVG(), K_BLANK_IMAGE, MultiCell(), printTemplate(), SetFont(), SetLineStyle(), SetTextColorArray(), SetX(), SetY() und startTemplate().

Wird benutzt von setHeader().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

hyphenateText (   $text,
  $patterns,
  $dictionary = array(),
  $leftmin = 1,
  $rightmin = 2,
  $charmin = 1,
  $charmax = 8 
)

Returns text with soft hyphens.

Parameter
$text(string) text to process
$patterns(mixed) Array of hypenation patterns or a TEX file containing hypenation patterns. TEX patterns can be downloaded from http://www.ctan.org/tex-archive/language/hyph-utf8/tex/generic/hyph-utf8/patterns/
$dictionary(array) Array of words to be returned without applying the hyphenation algoritm.
$leftmin(int) Minimum number of character to leave on the left of the word without applying the hyphens.
$rightmin(int) Minimum number of character to leave on the right of the word without applying the hyphens.
$charmin(int) Minimum word length to apply the hyphenation algoritm.
$charmax(int) Maximum length of broken piece of word.
Rückgabe
array text with soft hyphens
Autor
Nicola Asuni
Seit
4.9.012 (2010-04-12)

Definiert in Zeile 22009 der Datei tcpdf.php.

Benutzt TCPDF_FONT_DATA\$uni_type, TCPDF_STATIC\empty_string(), TCPDF_STATIC\getHyphenPatternsFromTEX(), TCPDF_FONTS\UTF8ArrSubString() und TCPDF_FONTS\UTF8StringToArray().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

hyphenateWord (   $word,
  $patterns,
  $dictionary = array(),
  $leftmin = 1,
  $rightmin = 2,
  $charmin = 1,
  $charmax = 8 
)
protected

Returns an array of chars containing soft hyphens.

Parameter
$word(array) array of chars
$patterns(array) Array of hypenation patterns.
$dictionary(array) Array of words to be returned without applying the hyphenation algoritm.
$leftmin(int) Minimum number of character to leave on the left of the word without applying the hyphens.
$rightmin(int) Minimum number of character to leave on the right of the word without applying the hyphens.
$charmin(int) Minimum word length to apply the hyphenation algoritm.
$charmax(int) Maximum length of broken piece of word.
Rückgabe
array text with soft hyphens
Autor
Nicola Asuni
Seit
4.9.012 (2010-04-12)

Definiert in Zeile 21933 der Datei tcpdf.php.

Benutzt TCPDF_FONTS\unichr(), TCPDF_FONTS\UTF8ArrSubString() und TCPDF_FONTS\UTF8StringToArray().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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.

Parameter
$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
or a string containing some or all of the following characters (in any order):
  • L: left
  • T: top
  • R: right
  • B: bottom
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)))
$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.
Rückgabe
image information
Seit
1.1

Definiert in Zeile 6801 der Datei tcpdf.php.

Benutzt $dpi, $h, $img_rb_x, $img_rb_y, $k, $lMargin, $w, $x, $xobjid, $y, _out(), TCPDF_IMAGES\_parsejpeg(), TCPDF_IMAGES\_toJPEG(), TCPDF_IMAGES\_toPNG(), Cell(), checkPageRegions(), Error(), TCPDF_STATIC\fileGetContents(), fitBlock(), TCPDF_STATIC\get_mqr(), getHTMLUnitToUnits(), getImageBuffer(), TCPDF_IMAGES\getImageFileType(), TCPDF_STATIC\getObjFilename(), ImagePngAlpha(), Link(), pixelsToUnits(), TCPDF_STATIC\set_mqr(), TCPDF_IMAGES\setGDImageTransparency(), setImageBuffer() und SetY().

Wird benutzt von Annotation(), Header(), ImageEps(), ImagePngAlpha() und openHTMLTagHandler().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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).

Parameter
$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
or a string containing some or all of the following characters (in any order):
  • L: left
  • T: top
  • R: right
  • B: bottom
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)))
$fitonpage(boolean) if true the image is resized to not exceed page dimensions.
$fixoutvals(boolean) if true remove values outside the bounding box.
Autor
Valentin Schmidt, Nicola Asuni
Seit
3.1.000 (2008-06-09)

Definiert in Zeile 14791 der Datei tcpdf.php.

Benutzt $h, $img_rb_x, $img_rb_y, $k, $lMargin, $w, $x, $y, _out(), AddSpotColor(), Cell(), checkPageRegions(), Error(), TCPDF_STATIC\fileGetContents(), fitBlock(), Image(), Link() und SetY().

Wird benutzt von Header() und openHTMLTagHandler().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

ImagePngAlpha (   $file,
  $x,
  $y,
  $wpx,
  $hpx,
  $w,
  $h,
  $type,
  $link,
  $align,
  $resize,
  $dpi,
  $palign,
  $filehash = '' 
)
protected

Extract info from a PNG image with alpha channel using the Imagick or GD library.

Parameter
$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.
Autor
Nicola Asuni
Seit
4.3.007 (2008-12-04)
Siehe auch
Image()

Definiert in Zeile 7215 der Datei tcpdf.php.

Benutzt $alpha, $dpi, $h, $w, $x, $y, Error(), getGDgamma(), Image() und TCPDF_STATIC\objclone().

Wird benutzt von Image().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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
If the alignment is an empty string, then the pointer will be restored on the starting SVG position.
$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
or a string containing some or all of the following characters (in any order):
  • L: left
  • T: top
  • R: right
  • B: bottom
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)))
$fitonpage(boolean) if true the image is resized to not exceed page dimensions.
Autor
Nicola Asuni
Seit
5.0.000 (2010-05-02)

Definiert in Zeile 22635 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\fileGetContents().

Wird benutzt von Header() und openHTMLTagHandler().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

IncludeJS (   $script)

Adds a javascript

Parameter
$script(string) Javascript code
Autor
Johannes G, Nicola Asuni
Seit
2.1.002 (2008-02-12)

Definiert in Zeile 12503 der Datei tcpdf.php.

inPageBody ( )
protected

Check if we are on the page body (excluding page header and footer).

Rückgabe
true if we are not in page header nor in page footer, false otherwise.
Seit
5.9.091 (2011-06-15)

Definiert in Zeile 3600 der Datei tcpdf.php.

Wird benutzt von checkPageBreak(), MultiCell(), Write() und writeHTML().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

isCharDefined (   $char,
  $font = '',
  $style = '' 
)

Return true in the character is present in the specified font.

Parameter
$char(mixed) Character to check (integer value or string)
$font(string) Font name (family name).
$style(string) Font style.
Rückgabe
(boolean) true if the char is defined, false otherwise.
Seit
5.9.153 (2012-03-28)

Definiert in Zeile 4621 der Datei tcpdf.php.

Benutzt $FontFamily, AddFont(), TCPDF_STATIC\empty_string(), getFontBuffer() und TCPDF_FONTS\UTF8StringToArray().

Wird benutzt von getCellCode() und replaceChar().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

isRTLTextDir ( )

Return the current temporary RTL status

Rückgabe
boolean
Seit
4.8.014 (2009-11-04)

Definiert in Zeile 2393 der Datei tcpdf.php.

Wird benutzt von Write() und writeHTML().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

isUnicodeFont ( )

Return true if the current font is unicode type.

Rückgabe
true for unicode font, false otherwise.
Autor
Nicola Asuni
Seit
5.8.002 (2010-08-14)

Definiert in Zeile 22133 der Datei tcpdf.php.

Wird benutzt von getAliasNbPages(), getAliasNumPage(), getAliasRightShift(), GetArrStringWidth(), getCellCode(), GetNumChars(), getPageGroupAlias(), getPageNumGroupAlias(), getSpaceString(), Write() und writeHTML().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

lastPage (   $resetmargins = false)

Reset pointer to the last document page.

Parameter
$resetmargins(boolean) if true reset left, right, top margins and Y position.
Seit
2.0.000 (2008-01-04)
Siehe auch
setPage(), getPage(), getNumPages()

Definiert in Zeile 3029 der Datei tcpdf.php.

Benutzt getNumPages() und setPage().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Line (   $x1,
  $y1,
  $x2,
  $y2,
  $style = array() 
)

Draws a line between two points.

Parameter
$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).
Seit
1.0
Siehe auch
SetLineWidth(), SetDrawColor(), SetLineStyle()

Definiert in Zeile 11503 der Datei tcpdf.php.

Benutzt _out(), _outLine(), _outPoint() und SetLineStyle().

Wird benutzt von Arrow(), cropMark(), openHTMLTagHandler(), Rect() und registrationMarkCMYK().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

LinearGradient (   $x,
  $y,
  $w,
  $h,
  $col1 = array(),
  $col2 = array(),
  $coords = array(0,0,1,0) 
)

Paints a linear colour gradient.

Parameter
$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).
Autor
Andreas W, Nicola Asuni
Seit
3.1.000 (2008-06-09)

Definiert in Zeile 14267 der Datei tcpdf.php.

Benutzt $h, $w, $x, $y, Clip() und Gradient().

Wird benutzt von colorRegistrationBar().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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
Seit
1.5
Siehe auch
AddLink(), Annotation(), Cell(), Write(), Image()

Definiert in Zeile 4735 der Datei tcpdf.php.

Benutzt $h, $w, $x, $y und Annotation().

Wird benutzt von getCellCode(), Image() und ImageEps().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

ListBox (   $name,
  $w,
  $h,
  $values,
  $prop = array(),
  $opt = array(),
  $x = '',
  $y = '',
  $js = false 
)

Creates a List-box field

Parameter
$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).
Autor
Nicola Asuni
Seit
4.8.000 (2009-09-07)

Definiert in Zeile 12879 der Datei tcpdf.php.

Benutzt $h, $w, $x, $y, _addfield() und checkPageRegions().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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.

Parameter
$h(float) The height of the break. By default, the value equals the height of the last printed cell.
$cell(boolean) if true add the current left (or right o for RTL) padding to the X coordinate
Seit
1.0
Siehe auch
Cell()

Definiert in Zeile 7337 der Datei tcpdf.php.

Benutzt $h und $lasth.

Wird benutzt von Footer(), setRTL() und writeHTML().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

MirrorH (   $x = '')

Horizontal Mirroring.

Parameter
$x(int) abscissa of the point. Default is current x position
Seit
2.1.000 (2008-01-07)
Siehe auch
StartTransform(), StopTransform()

Definiert in Zeile 11088 der Datei tcpdf.php.

Benutzt $x und Scale().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

MirrorL (   $angle = 0,
  $x = '',
  $y = '' 
)

Reflection against a straight line through point (x, y) with the gradient angle (angle).

Parameter
$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
Seit
2.1.000 (2008-01-07)
Siehe auch
StartTransform(), StopTransform()

Definiert in Zeile 11124 der Datei tcpdf.php.

Benutzt $x, $y, Rotate() und Scale().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

MirrorP (   $x = '',
  $y = '' 
)

Point reflection mirroring.

Parameter
$x(int) abscissa of the point. Default is current x position
$y(int) ordinate of the point. Default is current y position
Seit
2.1.000 (2008-01-07)
Siehe auch
StartTransform(), StopTransform()

Definiert in Zeile 11111 der Datei tcpdf.php.

Benutzt $x, $y und Scale().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

MirrorV (   $y = '')

Verical Mirroring.

Parameter
$y(int) ordinate of the point. Default is current y position
Seit
2.1.000 (2008-01-07)
Siehe auch
StartTransform(), StopTransform()

Definiert in Zeile 11099 der Datei tcpdf.php.

Benutzt $y und Scale().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

movePage (   $frompage,
  $topage 
)

Move a page to a previous position.

Parameter
$frompage(int) number of the source page
$topage(int) number of the destination page (must be less than $frompage)
Rückgabe
true in case of success, false in case of error.
Seit
4.5.000 (2009-01-02)

Definiert in Zeile 20826 der Datei tcpdf.php.

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.

Parameter
$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
or a string containing some or all of the following characters (in any order):
  • L: left
  • T: top
  • R: right
  • B: bottom
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)))
$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
General font stretching and scaling values will be preserved when possible.
$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
. This feature works only when $ishtml=false and the cell must fit in a single page.
$fitcell(boolean) if true attempt to fit all the text within the cell by reducing the font size (do not work in HTML mode).
Rückgabe
int Return the number of cells or 1 for html mode.
Seit
1.3
Siehe auch
SetFont(), SetDrawColor(), SetFillColor(), SetTextColor(), SetLineWidth(), Cell(), Write(), SetAutoPageBreak()

Definiert in Zeile 5764 der Datei tcpdf.php.

Benutzt $bMargin, $cell_margin, $cell_padding, $check_page_regions, $current_column, $FontSizePt, $h, $lMargin, $num_columns, $page, $rMargin, $tMargin, $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() und writeHTML().

Wird benutzt von Header(), TextField(), writeHTML() und writeHTMLCell().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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

Seit
1.0
Siehe auch
AddPage(), Close()

Definiert in Zeile 2926 der Datei tcpdf.php.

Wird benutzt von startPage().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

openHTMLTagHandler (   $dom,
  $key,
  $cell 
)
protected

Process opening tags.

Parameter
$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).
Rückgabe
$dom array

Definiert in Zeile 18598 der Datei tcpdf.php.

Benutzt $cell_padding, $form_action, $h, $k, $listindent, $listindentlevel, $listnum, $lisymbol, $lMargin, $n, $page, $rMargin, $w, $x, $y, addHTMLVertSpace(), AddLink(), Button(), CheckBox(), checkPageBreak(), TCPDF_STATIC\empty_string(), Error(), getCellHeight(), getGraphicVars(), getHTMLUnitToUnits(), TCPDF_IMAGES\getImageFileType(), GetLineWidth(), GetStringWidth(), GetX(), GetY(), Image(), ImageEps(), ImageSVG(), K_TCPDF_CALLS_IN_HTML, Line(), RadioButton(), SetCellPadding(), SetLineWidth(), SetLink(), setTempRTL(), SetXY() und TextField().

Wird benutzt von writeHTML().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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)
Seit
1.0
Siehe auch
Close()

Definiert in Zeile 7528 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\$byterange_string, Close(), Error(), getBuffer(), TCPDF_STATIC\getObjFilename() und TCPDF_STATIC\sendOutputData().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

PageNo ( )

Returns the current page number.

Rückgabe
int page number
Seit
1.0
Siehe auch
getAliasNbPages()

Definiert in Zeile 3676 der Datei tcpdf.php.

Benutzt $page.

Wird benutzt von Bookmark(), PageNoFormatted() und setDestination().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

PageNoFormatted ( )

Returns the current page number formatted as a string.

Seit
4.2.005 (2008-11-06)
Siehe auch
PaneNo(), formatPageNumber()

Definiert in Zeile 13646 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\formatPageNumber() und PageNo().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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.

Parameter
$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.
Autor
Maxime Delorme, Nicola Asuni
Seit
3.1.000 (2008-06-09)

Definiert in Zeile 14726 der Datei tcpdf.php.

Benutzt PieSectorXY().

Wird benutzt von registrationMark() und registrationMarkCMYK().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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.
Autor
Maxime Delorme, Nicola Asuni
Seit
3.1.000 (2008-06-09)

Definiert in Zeile 14747 der Datei tcpdf.php.

Benutzt _out(), _outellipticalarc() und TCPDF_STATIC\getPathPaintOperator().

Wird benutzt von PieSector().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

pixelsToUnits (   $px)

Converts pixels to User's Units.

Parameter
$px(int) pixels
Rückgabe
float value in user's unit
Siehe auch
setImageScale(), getImageScale()

Definiert in Zeile 10436 der Datei tcpdf.php.

Wird benutzt von Image().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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).
Siehe auch
SetLineStyle()
Seit
3.0008 (2008-05-12)

Definiert in Zeile 11634 der Datei tcpdf.php.

Benutzt _out(), _outCurve(), _outPoint(), TCPDF_STATIC\getPathPaintOperator(), SetFillColorArray() und SetLineStyle().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Polygon (   $p,
  $style = '',
  $line_style = array(),
  $fill_color = array(),
  $closed = true 
)

Draws a polygon.

Parameter
$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: If a key is not present or is null, not draws the line. Default value is 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).
$closed(boolean) if true the polygon is closes, otherwise will remain open
Seit
2.1.000 (2008-01-08)

Definiert in Zeile 11883 der Datei tcpdf.php.

Benutzt _out(), _outLine(), _outPoint(), TCPDF_STATIC\getPathPaintOperator(), SetFillColorArray() und SetLineStyle().

Wird benutzt von Arrow(), PolyLine(), RegularPolygon() und StarPolygon().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

PolyLine (   $p,
  $style = '',
  $line_style = array(),
  $fill_color = array() 
)

Draws a polygonal line

Parameter
$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: If a key is not present or is null, not draws the line. Default value is 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).
Seit
4.8.003 (2009-09-15)

Definiert in Zeile 11864 der Datei tcpdf.php.

Benutzt Polygon().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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.

Parameter
$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.
Autor
Nicola Asuni
Seit
5.8.017 (2010-08-24)
Siehe auch
startTemplate(), endTemplate()

Definiert in Zeile 22282 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\getTransformationMatrixProduct().

Wird benutzt von Header().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

putHtmlListBullet (   $listdepth,
  $listtype = '',
  $size = 10 
)
protected

Output an HTML list bullet or ordered item symbol

Parameter
$listdepth(int) list nesting level
$listtype(string) type of list
$size(float) current font size
Seit
4.4.004 (2008-12-10)

Definiert in Zeile 20221 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\empty_string(), TCPDF_STATIC\intToRoman() und TCPDF_FONTS\unichr().

Wird benutzt von writeHTML().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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.
Autor
Andreas W, Nicola Asuni
Seit
3.1.000 (2008-06-09)

Definiert in Zeile 14285 der Datei tcpdf.php.

Benutzt $h, $w, $x, $y, Clip() und Gradient().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

RadioButton (   $name,
  $w,
  $prop = array(),
  $opt = array(),
  $onvalue = 'On',
  $checked = false,
  $x = '',
  $y = '',
  $js = false 
)

Creates a RadioButton field.

Parameter
$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).
Autor
Nicola Asuni
Seit
4.8.000 (2009-09-07)

Definiert in Zeile 12776 der Datei tcpdf.php.

Benutzt $k, $n, $page, $w, $x, $y, _addfield(), AddFont(), Annotation(), checkPageRegions(), TCPDF_STATIC\empty_string(), getAbsFontMeasure(), TCPDF_STATIC\getAnnotOptFromJSProp(), getFontBuffer() und getFormDefaultProp().

Wird benutzt von openHTMLTagHandler().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

readDiskCache (   $filename)
protected

Read data from a temporary file on filesystem.

Parameter
$filename(string) file name
Rückgabe
mixed retrieved data
Seit
4.5.000 (2008-12-31)

Definiert in Zeile 20596 der Datei tcpdf.php.

Rect (   $x,
  $y,
  $w,
  $h,
  $style = '',
  $border_style = array(),
  $fill_color = array() 
)

Draws a rectangle.

Parameter
$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().
If a key is not present or is null, the correspondent border is not drawn. 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).
Seit
1.0
Siehe auch
SetLineStyle()

Definiert in Zeile 11533 der Datei tcpdf.php.

Benutzt $h, $w, $x, $y, _outRect(), TCPDF_STATIC\getPathPaintOperator(), Line(), SetFillColorArray() und SetLineStyle().

Wird benutzt von colorRegistrationBar(), RoundedRectXY(), write1DBarcode() und write2DBarcode().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

registrationMark (   $x,
  $y,
  $r,
  $double = false,
  $cola = array(100,100,100,100,'All'),
  $colb = array(0,0,0,0,'None') 
)

Paints a registration mark

Parameter
$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').
Autor
Nicola Asuni
Seit
4.9.000 (2010-03-26)

Definiert in Zeile 14196 der Datei tcpdf.php.

Benutzt $x, $y, Circle(), PieSector() und SetFillColorArray().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

registrationMarkCMYK (   $x,
  $y,
  $r 
)

Paints a CMYK registration mark

Parameter
$x(float) abscissa of the registration mark center.
$y(float) ordinate of the registration mark center.
$r(float) radius of the crop mark.
Autor
Nicola Asuni
Seit
6.0.038 (2013-09-30)

Definiert in Zeile 14223 der Datei tcpdf.php.

Benutzt $x, $y, Circle(), Line(), PieSector() und SetFillColorArray().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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.

Parameter
$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: If a key is not present or is null, not draws the side. Default value is default line style (empty array).
$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).
Seit
2.1.000 (2008-01-08)

Definiert in Zeile 11984 der Datei tcpdf.php.

Benutzt Circle() und Polygon().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

removePageRegion (   $key)

Remove a single no-write region.

Parameter
$key(int) region key
Autor
Nicola Asuni
Seit
5.9.003 (2010-10-13)
Siehe auch
setPageRegions(), getPageRegions()

Definiert in Zeile 22514 der Datei tcpdf.php.

replaceBuffer (   $data)
protected

Replace the buffer content

Parameter
$data(string) data
Seit
5.5.000 (2010-06-22)

Definiert in Zeile 20624 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\empty_string() und TCPDF_STATIC\getObjFilename().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

replaceChar (   $oldchar,
  $newchar 
)
protected

Replace a char if is defined on the current font.

Parameter
$oldchar(int) Integer code (unicode) of the character to replace.
$newchar(int) Integer code (unicode) of the new character.
Rückgabe
int the replaced char or the old char in case the new char i not defined
Seit
5.9.167 (2012-06-22)

Definiert in Zeile 5538 der Datei tcpdf.php.

Benutzt isCharDefined().

Wird benutzt von getCellCode().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

replaceMissingChars (   $text,
  $font = '',
  $style = '',
  $subs = array() 
)

Replace missing font characters on selected font with specified substitutions.

Parameter
$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.
Rückgabe
(string) Processed text.
Seit
5.9.153 (2012-03-28)

Definiert in Zeile 4648 der Datei tcpdf.php.

Benutzt $FontFamily, $k, AddFont(), TCPDF_STATIC\empty_string(), getFontBuffer(), TCPDF_FONTS\UniArrSubString(), TCPDF_FONTS\UTF8ArrayToUniArray() und TCPDF_FONTS\UTF8StringToArray().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

replaceRightShiftPageNumAliases (   $page,
  $aliases,
  $diff 
)
protected

Replace right shift page number aliases with spaces to correct right alignment. This works perfectly only when using monospaced fonts.

Parameter
$page(string) Page content.
$aliases(array) Array of page aliases.
$diff(int) initial difference to add.
Rückgabe
replaced page content.

Definiert in Zeile 7833 der Datei tcpdf.php.

Benutzt $page und TCPDF_FONTS\UTF8ToUTF16BE().

Wird benutzt von _putpages().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

resetColumns ( )

Remove columns and reset page margins.

Seit
5.9.072 (2011-04-26)

Definiert in Zeile 21690 der Datei tcpdf.php.

resetHeaderTemplate ( )

Reset the xobject template used by Header() method.

Definiert in Zeile 3361 der Datei tcpdf.php.

resetLastH ( )

Reset the last cell height.

Seit
5.9.000 (2010-10-03)

Definiert in Zeile 2427 der Datei tcpdf.php.

Benutzt getCellHeight().

Wird benutzt von getNumLines(), MultiCell() und writeHTML().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

rollbackTransaction (   $self = false)

This method allows to undo the latest transaction by returning the latest saved TCPDF object with startTransaction().

Parameter
$self(boolean) if true restores current class object to previous state without the need of reassignment via the returned value.
Rückgabe
TCPDF object.
Seit
4.5.029 (2009-03-19)

Definiert in Zeile 21626 der Datei tcpdf.php.

Wird benutzt von writeHTML().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

Rotate (   $angle,
  $x = '',
  $y = '' 
)

Rotate object.

Parameter
$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
Seit
2.1.000 (2008-01-07)
Siehe auch
StartTransform(), StopTransform()

Definiert in Zeile 11181 der Datei tcpdf.php.

Benutzt $k, $x, $y und Transform().

Wird benutzt von MirrorL().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

RoundedRect (   $x,
  $y,
  $w,
  $h,
  $r,
  $round_corner = '1111',
  $style = '',
  $border_style = array(),
  $fill_color = array() 
)

Draws a rounded rectangle.

Parameter
$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).
Seit
2.1.000 (2008-01-08)

Definiert in Zeile 12074 der Datei tcpdf.php.

Benutzt $h, $w, $x, $y und RoundedRectXY().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

RoundedRectXY (   $x,
  $y,
  $w,
  $h,
  $rx,
  $ry,
  $round_corner = '1111',
  $style = '',
  $border_style = array(),
  $fill_color = array() 
)

Draws a rounded rectangle.

Parameter
$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).
Seit
4.9.019 (2010-04-22)

Definiert in Zeile 12093 der Datei tcpdf.php.

Benutzt $h, $w, $x, $y, _out(), _outCurve(), _outLine(), _outPoint(), TCPDF_STATIC\getPathPaintOperator(), Rect(), SetFillColorArray() und SetLineStyle().

Wird benutzt von RoundedRect().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

Scale (   $s_x,
  $s_y,
  $x = '',
  $y = '' 
)

Vertical and horizontal non-proportional Scaling.

Parameter
$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
Seit
2.1.000 (2008-01-07)
Siehe auch
StartTransform(), StopTransform()

Definiert in Zeile 11055 der Datei tcpdf.php.

Benutzt $k, $x, $y, Error() und Transform().

Wird benutzt von MirrorH(), MirrorL(), MirrorP(), MirrorV(), ScaleX(), ScaleXY() und ScaleY().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

ScaleX (   $s_x,
  $x = '',
  $y = '' 
)

Horizontal Scaling.

Parameter
$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
Seit
2.1.000 (2008-01-07)
Siehe auch
StartTransform(), StopTransform()

Definiert in Zeile 11015 der Datei tcpdf.php.

Benutzt $x, $y und Scale().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

ScaleXY (   $s,
  $x = '',
  $y = '' 
)

Vertical and horizontal proportional Scaling.

Parameter
$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
Seit
2.1.000 (2008-01-07)
Siehe auch
StartTransform(), StopTransform()

Definiert in Zeile 11041 der Datei tcpdf.php.

Benutzt $x, $y und Scale().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

ScaleY (   $s_y,
  $x = '',
  $y = '' 
)

Vertical Scaling.

Parameter
$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
Seit
2.1.000 (2008-01-07)
Siehe auch
StartTransform(), StopTransform()

Definiert in Zeile 11028 der Datei tcpdf.php.

Benutzt $x, $y und Scale().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

segSVGContentHandler (   $parser,
  $data 
)
protected

Sets the character data handler function for the XML parser.

Parameter
$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.
Autor
Nicola Asuni
Seit
5.0.000 (2010-05-02)

Definiert in Zeile 24306 der Datei tcpdf.php.

selectColumn (   $col = '')

Set position at a given column

Parameter
$col(int) column number (from 0 to getNumberOfColumns()-1); empty string = current column.
Seit
4.9.001 (2010-03-28)

Definiert in Zeile 21717 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\empty_string().

Wird benutzt von AcceptPageBreak(), MultiCell() und writeHTML().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

serializeTCPDFtagParameters (   $pararray)

Serialize an array of parameters to be used with TCPDF tag in HTML code.

Parameter
$pararray(array) parameters array
Rückgabe
sting containing serialized data
Seit
4.9.006 (2010-04-02)
Veraltet:

Definiert in Zeile 17006 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\serializeTCPDFtagParameters().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

SetAbsX (   $x)

Set the absolute X coordinate of the current pointer.

Parameter
$x(float) The value of the abscissa in user units.
Seit
5.9.186 (2012-09-13)
Siehe auch
setAbsX(), setAbsY(), SetAbsXY()

Definiert in Zeile 7490 der Datei tcpdf.php.

Benutzt $x.

Wird benutzt von SetAbsXY().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

SetAbsXY (   $x,
  $y 
)

Set the absolute X and Y coordinates of the current pointer.

Parameter
$x(float) The value of the abscissa in user units.
$y(float) (float) The value of the ordinate in user units.
Seit
5.9.186 (2012-09-13)
Siehe auch
setAbsX(), setAbsY(), SetAbsXY()

Definiert in Zeile 7513 der Datei tcpdf.php.

Benutzt $x, $y, SetAbsX() und SetAbsY().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

SetAbsY (   $y)

Set the absolute Y coordinate of the current pointer.

Parameter
$y(float) (float) The value of the ordinate in user units.
Seit
5.9.186 (2012-09-13)
Siehe auch
setAbsX(), setAbsY(), SetAbsXY()

Definiert in Zeile 7501 der Datei tcpdf.php.

Benutzt $y.

Wird benutzt von SetAbsXY().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setAlpha (   $stroking = 1,
  $bm = 'Normal',
  $nonstroking = '',
  $ais = false 
)

Set alpha for stroking (CA) and non-stroking (ca) operations.

Parameter
$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)
Seit
3.0.000 (2008-03-27)

Definiert in Zeile 13866 der Datei tcpdf.php.

Benutzt addExtGState(), TCPDF_STATIC\empty_string() und setExtGState().

Wird benutzt von Cell().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

SetAuthor (   $author)

Defines the author of the document.

Parameter
$author(string) The name of the author.
Seit
1.2
Siehe auch
SetCreator(), SetKeywords(), SetSubject(), SetTitle()

Definiert in Zeile 2876 der Datei tcpdf.php.

Benutzt $author.

SetAutoPageBreak (   $auto,
  $margin = 0 
)

Enables or disables the automatic page breaking mode. When enabling, the second parameter is the distance from the bottom of the page that defines the triggering limit. By default, the mode is on and the margin is 2 cm.

Parameter
$auto(boolean) Boolean indicating if mode should be on or off.
$margin(float) Distance from the bottom of the page.
Seit
1.0
Siehe auch
Cell(), MultiCell(), AcceptPageBreak()

Definiert in Zeile 2777 der Datei tcpdf.php.

Wird benutzt von __construct(), Close(), setPage() und setPageOrientation().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setBarcode (   $bc = '')

Set document barcode.

Parameter
$bc(string) barcode

Definiert in Zeile 15110 der Datei tcpdf.php.

SetBooklet (   $booklet = true,
  $inner = -1,
  $outer = -1 
)

Set the booklet mode for double-sided pages.

Parameter
$booklet(boolean) true set the booklet mode on, false otherwise.
$inner(float) Inner page margin.
$outer(float) Outer page margin.
Seit
4.2.000 (2008-10-29)

Definiert in Zeile 20051 der Datei tcpdf.php.

setBookmark (   $txt,
  $level = 0,
  $y = -1,
  $page = '',
  $style = '',
  $color = array(0,0,0),
  $x = -1,
  $link = '' 
)

Adds a bookmark - alias for Bookmark().

Parameter
$txt(string) Bookmark description.
$level(int) Bookmark level (minimum value is 0).
$y(float) Y position in user units of the bookmark on the selected page (default = -1 = current position; 0 = page start;).
$page(int) Target page number (leave empty for current page).
$style(string) Font style: B = Bold, I = Italic, BI = Bold + Italic.
$color(array) RGB color array (values from 0 to 255).
$x(float) X position in user units of the bookmark on the selected page (default = -1 = current position;).
$link(mixed) URL, or numerical link ID, or named destination (# character followed by the destination name), or embedded file (* character followed by the file name).

Definiert in Zeile 12301 der Datei tcpdf.php.

Benutzt $page, $x, $y und Bookmark().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

setBuffer (   $data)
protected

Set buffer content (always append data).

Parameter
$data(string) data
Seit
4.5.000 (2009-01-02)

Definiert in Zeile 20606 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\empty_string() und TCPDF_STATIC\getObjFilename().

Wird benutzt von _out().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setCellHeightRatio (   $h)

Set the height of the cell (line height) respect the font height.

Parameter
$h(int) cell proportion respect font height (typical value = 1.25).
Seit
3.0.014 (2008-06-04)

Definiert in Zeile 13931 der Datei tcpdf.php.

Benutzt $h.

setCellMargins (   $left = '',
  $top = '',
  $right = '',
  $bottom = '' 
)

Set the internal Cell margins.

Parameter
$left(float) left margin
$top(float) top margin
$right(float) right margin
$bottom(float) bottom margin
Seit
5.9.000 (2010-10-03)
Siehe auch
getCellMargins()

Definiert in Zeile 2669 der Datei tcpdf.php.

Wird benutzt von __construct() und MultiCell().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

SetCellPadding (   $pad)

Set the same internal Cell padding for top, right, bottom, left-

Parameter
$pad(float) internal padding.
Seit
2.1.000 (2008-01-09)
Siehe auch
getCellPaddings(), setCellPaddings()

Definiert in Zeile 2614 der Datei tcpdf.php.

Wird benutzt von openHTMLTagHandler(), setFooter(), setHeader(), Write() und write1DBarcode().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setCellPaddings (   $left = '',
  $top = '',
  $right = '',
  $bottom = '' 
)

Set the internal Cell paddings.

Parameter
$left(float) left padding
$top(float) top padding
$right(float) right padding
$bottom(float) bottom padding
Seit
5.9.000 (2010-10-03)
Siehe auch
getCellPaddings(), SetCellPadding()

Definiert in Zeile 2633 der Datei tcpdf.php.

Wird benutzt von __construct().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setColor (   $type,
  $col1 = 0,
  $col2 = -1,
  $col3 = -1,
  $col4 = -1,
  $ret = false,
  $name = '' 
)

Defines the color used by the specified type ('draw', 'fill', 'text').

Parameter
$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)
Rückgabe
(string) The PDF command or empty string.
Seit
5.9.125 (2011-10-03)

Definiert in Zeile 3879 der Datei tcpdf.php.

Benutzt $TextColor, _out(), AddSpotColor() und setSpotColor().

Wird benutzt von setColorArray(), SetDrawColor(), SetFillColor() und SetTextColor().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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.
Rückgabe
(string) The PDF command or empty string.
Seit
3.1.000 (2008-06-11)

Definiert in Zeile 3804 der Datei tcpdf.php.

Benutzt $k, $y und setColor().

Wird benutzt von SetDrawColorArray(), SetFillColorArray() und SetTextColorArray().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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).

Parameter
$columns(array)
Seit
4.9.001 (2010-03-28)

Definiert in Zeile 21703 der Datei tcpdf.php.

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.

Parameter
$compress(boolean) Boolean indicating if compression must be enabled.
Seit
1.4

Definiert in Zeile 2818 der Datei tcpdf.php.

Benutzt $compress.

Wird benutzt von __construct().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setContentMark (   $page = 0)
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.

Parameter
$page(int) page number (default is the current page)
Seit
4.6.021 (2009-07-20)

Definiert in Zeile 3223 der Datei tcpdf.php.

Benutzt $page.

Wird benutzt von MultiCell() und setPageMark().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

SetCreator (   $creator)

Defines the creator of the document. This is typically the name of the application that generates the PDF.

Parameter
$creator(string) The name of the creator.
Seit
1.2
Siehe auch
SetAuthor(), SetKeywords(), SetSubject(), SetTitle()

Definiert in Zeile 2898 der Datei tcpdf.php.

Benutzt $creator.

SetDefaultMonospacedFont (   $font)

Defines the default monospaced font.

Parameter
$font(string) Font name.
Seit
4.5.025

Definiert in Zeile 4685 der Datei tcpdf.php.

setDefaultTableColumns (   $cols = 4)

Set the default number of columns in a row for HTML tables.

Parameter
$cols(int) number of columns
Seit
3.0.014 (2008-06-04)

Definiert in Zeile 13921 der Datei tcpdf.php.

setDestination (   $name,
  $y = -1,
  $page = '',
  $x = -1 
)

Add a Named Destination. NOTE: destination names are unique, so only last entry will be saved.

Parameter
$name(string) Destination name.
$y(float) Y position in user units of the destiantion on the selected page (default = -1 = current position; 0 = page start;).
$page(int) Target page number (leave empty for current page).
$x(float) X position in user units of the destiantion on the selected page (default = -1 = current position;).
Rückgabe
(string) Stripped named destination identifier or false in case of error.
Autor
Christian Deligant, Nicola Asuni
Seit
5.9.097 (2011-06-23)

Definiert in Zeile 12228 der Datei tcpdf.php.

Benutzt $h, $page, $w, $x, $y, TCPDF_STATIC\empty_string(), TCPDF_STATIC\encodeNameObject(), GetX(), GetY() und PageNo().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

SetDisplayMode (   $zoom,
  $layout = 'SinglePage',
  $mode = 'UseNone' 
)

Defines the way the document is to be displayed by the viewer.

Parameter
$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
Seit
1.2

Definiert in Zeile 2801 der Datei tcpdf.php.

Benutzt Error(), TCPDF_STATIC\getPageLayoutMode() und TCPDF_STATIC\getPageMode().

Wird benutzt von __construct().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setDocCreationTimestamp (   $time)

Set the document creation timestamp

Parameter
$time(mixed) Document creation timestamp in seconds or date-time string.
Seit
5.9.152 (2012-03-23)

Definiert in Zeile 10157 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\getTimestamp().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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.

Parameter
$unicode(boolean) if true set the meta information in Unicode
Seit
5.9.027 (2010-12-01)

Definiert in Zeile 2843 der Datei tcpdf.php.

setDocModificationTimestamp (   $time)

Set the document modification timestamp

Parameter
$time(mixed) Document modification timestamp in seconds or date-time string.
Seit
5.9.152 (2012-03-23)

Definiert in Zeile 10170 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\getTimestamp().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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.

Parameter
$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)
Rückgabe
string the PDF command
Seit
1.3
Siehe auch
SetDrawColorArray(), SetFillColor(), SetTextColor(), Line(), Rect(), Cell(), MultiCell()

Definiert in Zeile 3969 der Datei tcpdf.php.

Benutzt setColor().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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.

Parameter
$color(array) Array of colors (1, 3 or 4 values).
$ret(boolean) If true do not send the PDF command.
Rückgabe
string the PDF command
Seit
3.1.000 (2008-06-11)
Siehe auch
SetDrawColor()

Definiert in Zeile 3835 der Datei tcpdf.php.

Benutzt setColorArray().

Wird benutzt von Cell(), SetLineStyle(), write1DBarcode(), write2DBarcode() und writeHTML().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

SetDrawSpotColor (   $name,
  $tint = 100 
)

Defines the spot color used for all drawing operations (lines, rectangles and cell borders).

Parameter
$name(string) Name of the spot color.
$tint(float) Intensity of the color (from 0 to 100 ; 100 = full intensity by default).
Seit
4.0.024 (2008-09-12)
Siehe auch
AddSpotColor(), SetFillSpotColor(), SetTextSpotColor()

Definiert in Zeile 3765 der Datei tcpdf.php.

Benutzt setSpotColor().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

setEqualColumns (   $numcols = 0,
  $width = 0,
  $y = '' 
)

Set multiple columns of the same size

Parameter
$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)
Seit
4.9.001 (2010-03-28)

Definiert in Zeile 21658 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\empty_string().

Wird benutzt von Close().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setExtGState (   $gs)
protected

Add an extgstate

Parameter
$gs(array) extgstate
Seit
3.0.000 (2008-03-27)

Definiert in Zeile 13785 der Datei tcpdf.php.

Benutzt _out().

Wird benutzt von setAlpha() und setOverprint().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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!

Parameter
$xmp(string) Custom XMP data.
Seit
5.9.128 (2011-10-06)

Definiert in Zeile 9470 der Datei tcpdf.php.

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.

Parameter
$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).
Rückgabe
(string) The PDF command.
Seit
1.3
Siehe auch
SetFillColorArray(), SetDrawColor(), SetTextColor(), Rect(), Cell(), MultiCell()

Definiert in Zeile 3986 der Datei tcpdf.php.

Benutzt setColor().

Wird benutzt von Button().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$color(array) Array of colors (1, 3 or 4 values).
$ret(boolean) If true do not send the PDF command.
Seit
3.1.000 (2008-6-11)
Siehe auch
SetFillColor()

Definiert in Zeile 3849 der Datei tcpdf.php.

Benutzt setColorArray().

Wird benutzt von Cell(), colorRegistrationBar(), Curve(), Ellipse(), Polycurve(), Polygon(), Rect(), registrationMark(), registrationMarkCMYK(), RoundedRectXY() und writeHTML().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

SetFillSpotColor (   $name,
  $tint = 100 
)

Defines the spot color used for all filling operations (filled rectangles and cell backgrounds).

Parameter
$name(string) Name of the spot color.
$tint(float) Intensity of the color (from 0 to 100 ; 100 = full intensity by default).
Seit
4.0.024 (2008-09-12)
Siehe auch
AddSpotColor(), SetDrawSpotColor(), SetTextSpotColor()

Definiert in Zeile 3777 der Datei tcpdf.php.

Benutzt setSpotColor().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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


Parameter
$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)
It is also possible to pass an empty string. In that case, the current family is retained.
$style(string) Font style. Possible values are (case insensitive):
  • empty string: regular
  • B: bold
  • I: italic
  • U: underline
  • D: line through
  • O: overline
or any combination. The default value is regular. Bold and italic styles do not apply to Symbol and ZapfDingbats basic fonts or other fonts when not defined.
$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.
Autor
Nicola Asuni
Seit
1.0
Siehe auch
AddFont(), SetFontSize()

Definiert in Zeile 4446 der Datei tcpdf.php.

Benutzt $FontSizePt, AddFont(), getFontBuffer(), SetFontSize() und setFontSubBuffer().

Wird benutzt von __construct(), addHtmlLink(), Close(), GetArrStringWidth(), Header(), setFooter(), setHeader(), write1DBarcode() und writeHTML().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setFontBuffer (   $font,
  $data 
)
protected

Set font buffer content.

Parameter
$font(string) font key
$data(array) font data
Seit
4.5.000 (2009-01-02)

Definiert in Zeile 20763 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\getObjFilename().

Wird benutzt von AddFont().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

SetFontSize (   $size,
  $out = true 
)

Defines the size of the current font.

Parameter
$size(float) The font size in points.
$out(boolean) if true output the font size command, otherwise only set the font properties.
Seit
1.0
Siehe auch
SetFont()

Definiert in Zeile 4474 der Datei tcpdf.php.

Benutzt $k und _out().

Wird benutzt von MultiCell() und SetFont().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setFontSpacing (   $spacing = 0)

Set the amount to increase or decrease the space between characters in a text.

Parameter
$spacing(float) amount to increase or decrease the space between characters in a text (0 = default spacing)
Autor
Nicola Asuni
Seit
5.9.000 (2010-09-29)

Definiert in Zeile 22437 der Datei tcpdf.php.

Wird benutzt von writeHTML().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setFontStretching (   $perc = 100)

Set the percentage of character stretching.

Parameter
$perc(int) percentage of stretching (100 = no stretching)
Autor
Nicola Asuni
Seit
5.9.000 (2010-09-29)

Definiert in Zeile 22415 der Datei tcpdf.php.

Wird benutzt von writeHTML().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setFontSubBuffer (   $font,
  $key,
  $data 
)
protected

Set font buffer content.

Parameter
$font(string) font key
$key(string) font sub-key
$data(array) font data
Seit
4.5.000 (2009-01-02)

Definiert in Zeile 20789 der Datei tcpdf.php.

Wird benutzt von _enddoc(), AddFont(), getCellCode() und SetFont().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setFontSubsetting (   $enable = true)

Enable or disable default option for font subsetting.

Parameter
$enable(boolean) if true enable font subsetting by default.
Autor
Nicola Asuni
Seit
5.3.002 (2010-06-07)

Definiert in Zeile 22066 der Datei tcpdf.php.

setFooter ( )
protected

This method is used to render the page footer.

Seit
4.0.012 (2008-07-24)

Definiert in Zeile 3544 der Datei tcpdf.php.

Benutzt $footer_margin, $lasth, $original_lMargin, $original_rMargin, $page, $thead, $theadMargins, _out(), _outRestoreGraphicsState(), _outSaveGraphicsState(), Footer(), getGraphicVars(), SetCellPadding(), SetFont(), setGraphicVars() und SetXY().

Wird benutzt von endPage().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setFooterData (   $tc = array(0,0,0),
  $lc = array(0,0,0) 
)

Set footer data.

Parameter
$tc(array) RGB array color for text.
$lc(array) RGB array color for line.

Definiert in Zeile 3259 der Datei tcpdf.php.

setFooterFont (   $font)

Set footer font.

Parameter
$font(array) Array describing the basic font parameters: (family, style, size).
Seit
1.1

Definiert in Zeile 10339 der Datei tcpdf.php.

Wird benutzt von __construct().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setFooterMargin (   $fm = 10)

Set footer margin. (minimum distance between footer and bottom page margin)

Parameter
$fm(int) distance in user units

Definiert in Zeile 3308 der Datei tcpdf.php.

setFormDefaultProp (   $prop = array())

Set default properties for form fields.

Parameter
$prop(array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
Autor
Nicola Asuni
Seit
4.8.000 (2009-09-06)

Definiert in Zeile 12626 der Datei tcpdf.php.

setGraphicVars (   $gvars,
  $extended = false 
)
protected

Set graphic variables.

Parameter
$gvars(array) array of graphic variablesto restore
$extended(boolean) if true restore extended graphic variables
Seit
4.2.010 (2008-11-14)

Definiert in Zeile 20484 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\empty_string().

Wird benutzt von Close(), setFooter(), setHeader(), setTableHeader(), startPage(), write1DBarcode(), write2DBarcode() und writeHTML().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setHeader ( )
protected

This method is used to render the page header.

Seit
4.0.012 (2008-07-24)

Definiert in Zeile 3503 der Datei tcpdf.php.

Benutzt $lasth, $newline, $original_lMargin, $original_rMargin, $thead, $theadMargins, _outRestoreGraphicsState(), _outSaveGraphicsState(), Header(), SetCellPadding(), SetFont(), setGraphicVars() und SetXY().

Wird benutzt von startPage().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setHeaderData (   $ln = '',
  $lw = 0,
  $ht = '',
  $hs = '',
  $tc = array(0,0,0),
  $lc = array(0,0,0) 
)

Set header data.

Parameter
$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.

Definiert in Zeile 3244 der Datei tcpdf.php.

setHeaderFont (   $font)

Set header font.

Parameter
$font(array) Array describing the basic font parameters: (family, style, size).
Seit
1.1

Definiert in Zeile 10319 der Datei tcpdf.php.

Wird benutzt von __construct().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setHeaderMargin (   $hm = 10)

Set header margin. (minimum distance between header and top page margin)

Parameter
$hm(int) distance in user units

Definiert in Zeile 3288 der Datei tcpdf.php.

setHeaderTemplateAutoreset (   $val = true)

Set a flag to automatically reset the xobject template used by Header() method at each page.

Parameter
$val(boolean) set to true to reset Header xobject template at each page, false otherwise.

Definiert in Zeile 3370 der Datei tcpdf.php.

setHtmlLinksStyle (   $color = array(0,0,255),
  $fontstyle = 'U' 
)

Set the color and font style for HTML links.

Parameter
$color(array) RGB array of colors
$fontstyle(string) additional font styles to add
Seit
4.4.003 (2008-12-09)

Definiert in Zeile 20122 der Datei tcpdf.php.

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.

Parameter
$tagvs(array) array of tags and relative vertical spaces.
Seit
4.2.001 (2008-10-30)

Definiert in Zeile 20091 der Datei tcpdf.php.

setImageBuffer (   $image,
  $data 
)
protected

Set image buffer content.

Parameter
$image(string) image key
$data(array) image data
Rückgabe
int image index number
Seit
4.5.000 (2008-12-31)

Definiert in Zeile 20702 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\getObjFilename().

Wird benutzt von Image().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setImageScale (   $scale)

Set the adjusting factor to convert pixels to user units.

Parameter
$scale(float) adjusting factor to convert pixels to user units.
Autor
Nicola Asuni
Seit
1.5.2

Definiert in Zeile 2448 der Datei tcpdf.php.

setImageSubBuffer (   $image,
  $key,
  $data 
)
protected

Set image buffer content for a specified sub-key.

Parameter
$image(string) image key
$key(string) image sub-key
$data(array) image data
Seit
4.5.000 (2008-12-31)

Definiert in Zeile 20727 der Datei tcpdf.php.

Wird benutzt von _putimages().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setJPEGQuality (   $quality)

Set the default JPEG compression quality (1-100)

Parameter
$quality(int) JPEG quality, integer between 1 and 100
Seit
3.0.000 (2008-03-27)

Definiert in Zeile 13908 der Datei tcpdf.php.

SetKeywords (   $keywords)

Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.

Parameter
$keywords(string) The list of keywords.
Seit
1.2
Siehe auch
SetAuthor(), SetCreator(), SetSubject(), SetTitle()

Definiert in Zeile 2887 der Datei tcpdf.php.

Benutzt $keywords.

setLanguageArray (   $language)

Set language array.

Parameter
$language(array)
Seit
1.1

Definiert in Zeile 10359 der Datei tcpdf.php.

setLastH (   $h)

Set the last cell height.

Parameter
$h(float) cell height.
Autor
Nicola Asuni
Seit
1.53.0.TC034

Definiert in Zeile 2404 der Datei tcpdf.php.

Benutzt $h.

SetLeftMargin (   $margin)

Defines the left margin. The method can be called before creating the first page. If the current abscissa gets out of page, it is brought back to the margin.

Parameter
$margin(float) The margin.
Seit
1.4
Siehe auch
SetTopMargin(), SetRightMargin(), SetAutoPageBreak(), SetMargins()

Definiert in Zeile 2570 der Datei tcpdf.php.

SetLineStyle (   $style,
  $ret = false 
)

Set line style.

Parameter
$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.
Rückgabe
string the PDF command
Seit
2.1.000 (2008-01-08)

Definiert in Zeile 11344 der Datei tcpdf.php.

Benutzt _out() und SetDrawColorArray().

Wird benutzt von cropMark(), Curve(), Ellipse(), Footer(), getCellBorder(), Header(), Line(), Polycurve(), Polygon(), Rect() und RoundedRectXY().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$width(float) The width.
Seit
1.0
Siehe auch
Line(), Rect(), Cell(), MultiCell()

Definiert in Zeile 11301 der Datei tcpdf.php.

Benutzt _out().

Wird benutzt von openHTMLTagHandler().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

SetLink (   $link,
  $y = 0,
  $page = -1 
)

Defines the page and position a link points to.

Parameter
$link(int) The link identifier returned by AddLink()
$y(float) Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page)
$page(int) Number of target page; -1 indicates the current page. This is the default value
Seit
1.5
Siehe auch
AddLink()

Definiert in Zeile 4712 der Datei tcpdf.php.

Benutzt $page und $y.

Wird benutzt von addHtmlLink() und openHTMLTagHandler().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setListIndentWidth (   $width)

Set custom width for list indentation.

Parameter
$width(float) width of the indentation. Use negative value to disable it.
Seit
4.2.007 (2008-11-12)

Definiert in Zeile 20101 der Datei tcpdf.php.

setLIsymbol (   $symbol = '!')

Set the default bullet to be used as LI bullet symbol

Parameter
$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')
Seit
4.0.028 (2008-09-26)

Definiert in Zeile 20028 der Datei tcpdf.php.

SetMargins (   $left,
  $top,
  $right = -1,
  $keepmargins = false 
)

Defines the left, top and right margins.

Parameter
$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
Seit
1.0
Siehe auch
SetLeftMargin(), SetTopMargin(), SetRightMargin(), SetAutoPageBreak()

Definiert in Zeile 2548 der Datei tcpdf.php.

Benutzt $lMargin und $rMargin.

Wird benutzt von __construct().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setOpenCell (   $isopen)

Set the top/bottom cell sides to be open or closed when the cell cross the page.

Parameter
$isopen(boolean) if true keeps the top/bottom border open for the cell sides that cross the page.
Seit
4.2.010 (2008-11-14)

Definiert in Zeile 20111 der Datei tcpdf.php.

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).

Parameter
$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).
Seit
5.9.152 (2012-03-23)

Definiert in Zeile 13827 der Datei tcpdf.php.

Benutzt addExtGState(), TCPDF_STATIC\empty_string() und setExtGState().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

setPage (   $pnum,
  $resetmargins = false 
)

Move pointer at the specified document page and update page dimensions.

Parameter
$pnum(int) page number (1 ... numpages)
$resetmargins(boolean) if true reset left, right, top margins and Y position.
Seit
2.1.000 (2008-01-07)
Siehe auch
getPage(), lastpage(), getNumPages()

Definiert in Zeile 2982 der Datei tcpdf.php.

Benutzt $page, Error(), SetAutoPageBreak() und SetY().

Wird benutzt von lastPage(), MultiCell(), startPage() und writeHTML().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setPageBoxTypes (   $boxes)
protected

Set page boxes to be included on page descriptions.

Parameter
$boxes(array) Array of page boxes to set on document: ('MediaBox', 'CropBox', 'BleedBox', 'TrimBox', 'ArtBox').

Definiert in Zeile 7868 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\$pageboxes.

setPageBuffer (   $page,
  $data,
  $append = false 
)
protected

Set page buffer content.

Parameter
$page(int) page number
$data(string) page data
$append(boolean) if true append data, false replace.
Seit
4.5.000 (2008-12-31)

Definiert in Zeile 20658 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\getObjFilename().

Wird benutzt von _beginpage(), _out(), MultiCell() und writeHTML().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setPageFormat (   $format,
  $orientation = 'P' 
)
protected

Change the format of the current page

Parameter
$format(mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() documentation or an array of two numners (width, height) or an array containing the following measures and options:
  • ['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 in points
  • ['MediaBox']['lly'] : lower-left y coordinate in points
  • ['MediaBox']['urx'] : upper-right x coordinate in points
  • ['MediaBox']['ury'] : upper-right y coordinate in points
  • ['CropBox'] : the visible region of default user space:
  • ['CropBox']['llx'] : lower-left x coordinate in points
  • ['CropBox']['lly'] : lower-left y coordinate in points
  • ['CropBox']['urx'] : upper-right x coordinate in points
  • ['CropBox']['ury'] : upper-right y coordinate in points
  • ['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 in points
  • ['BleedBox']['lly'] : lower-left y coordinate in points
  • ['BleedBox']['urx'] : upper-right x coordinate in points
  • ['BleedBox']['ury'] : upper-right y coordinate in points
  • ['TrimBox'] : the intended dimensions of the finished page after trimming:
  • ['TrimBox']['llx'] : lower-left x coordinate in points
  • ['TrimBox']['lly'] : lower-left y coordinate in points
  • ['TrimBox']['urx'] : upper-right x coordinate in points
  • ['TrimBox']['ury'] : upper-right y coordinate in points
  • ['ArtBox'] : the extent of the page's meaningful content:
  • ['ArtBox']['llx'] : lower-left x coordinate in points
  • ['ArtBox']['lly'] : lower-left y coordinate in points
  • ['ArtBox']['urx'] : upper-right x coordinate in points
  • ['ArtBox']['ury'] : upper-right y coordinate in points
  • ['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
Seit
3.0.015 (2008-06-06)
Siehe auch
getPageSizeFromFormat()

Definiert in Zeile 2091 der Datei tcpdf.php.

Benutzt $page, TCPDF_STATIC\getPageSizeFromFormat(), TCPDF_STATIC\setPageBoxes() und setPageOrientation().

Wird benutzt von __construct() und _beginpage().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Seit
4.0.016 (2008-07-30)

Definiert in Zeile 3210 der Datei tcpdf.php.

Benutzt $page und setContentMark().

Wird benutzt von startPage().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setPageOrientation (   $orientation,
  $autopagebreak = '',
  $bottommargin = '' 
)

Set page orientation.

Parameter
$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.
Seit
3.0.015 (2008-06-06)

Definiert in Zeile 2205 der Datei tcpdf.php.

Benutzt $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() und TCPDF_STATIC\swapPageBoxCoordinates().

Wird benutzt von _beginpage(), setPageFormat() und setPageUnit().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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.
Autor
Nicola Asuni
Seit
5.9.003 (2010-10-13)
Siehe auch
addPageRegion(), getPageRegions()

Definiert in Zeile 22475 der Datei tcpdf.php.

setPageUnit (   $unit)

Set the units of measure for the document.

Parameter
$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.
Seit
3.0.015 (2008-06-06)

Definiert in Zeile 1999 der Datei tcpdf.php.

Benutzt $dpi, Error() und setPageOrientation().

Wird benutzt von __construct().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setPDFVersion (   $version = '1.7')

Set the PDF version (check PDF reference for valid values).

Parameter
$version(string) PDF document version.
Seit
3.1.000 (2008-06-09)

Definiert in Zeile 13950 der Datei tcpdf.php.

Wird benutzt von __construct().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setPrintFooter (   $val = true)

Set a flag to print page footer.

Parameter
$val(boolean) set to true to print the page footer (default), false otherwise.

Definiert in Zeile 3335 der Datei tcpdf.php.

setPrintHeader (   $val = true)

Set a flag to print page header.

Parameter
$val(boolean) set to true to print the page header (default), false otherwise.

Definiert in Zeile 3326 der Datei tcpdf.php.

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.

Parameter
$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')))
Seit
2.0.000 (2008-01-02)
Autor
Nicola Asuni

Definiert in Zeile 10864 der Datei tcpdf.php.

Benutzt _generateencryptionkey(), TCPDF_STATIC\convertHexStringToString(), Error(), TCPDF_STATIC\getRandomSeed() und TCPDF_STATIC\getUserPermissionCode().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

setRasterizeVectorImages (   $mode)

Enable/disable rasterization of vector images using ImageMagick library.

Parameter
$mode(boolean) if true enable rasterization, false otherwise.
Seit
5.0.000 (2010-04-27)

Definiert in Zeile 22055 der Datei tcpdf.php.

SetRightMargin (   $margin)

Defines the right margin. The method can be called before creating the first page.

Parameter
$margin(float) The margin.
Seit
1.5
Siehe auch
SetLeftMargin(), SetTopMargin(), SetAutoPageBreak(), SetMargins()

Definiert in Zeile 2600 der Datei tcpdf.php.

setRTL (   $enable,
  $resetx = true 
)

Enable or disable Right-To-Left language mode

Parameter
$enable(Boolean) if true enable Right-To-Left language mode.
$resetx(Boolean) if true reset the X position on direction change.
Seit
2.0.000 (2008-01-03)

Definiert in Zeile 2335 der Datei tcpdf.php.

Benutzt Ln().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

setSignature (   $signing_cert = '',
  $private_key = '',
  $private_key_password = '',
  $extracerts = '',
  $cert_type = 2,
  $info = array() 
)

Enable document signature (requires the OpenSSL Library). The digital signature improve document authenticity and integrity and allows o enable extra features on Acrobat Reader. To create self-signed signature: openssl req -x509 -nodes -days 365000 -newkey rsa:1024 -keyout tcpdf.crt -out tcpdf.crt To export crt to p12: openssl pkcs12 -export -in tcpdf.crt -out tcpdf.p12 To convert pfx certificate to pem: openssl pkcs12 -in tcpdf.pfx -out tcpdf.crt -nodes

Parameter
$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.
Autor
Nicola Asuni
Seit
4.6.005 (2009-04-24)

Definiert in Zeile 13421 der Datei tcpdf.php.

Benutzt $n und Error().

Wird benutzt von setUserRights().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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)

Parameter
$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.
Autor
Nicola Asuni
Seit
5.3.011 (2010-06-17)

Definiert in Zeile 13457 der Datei tcpdf.php.

Benutzt $h, $page, $w, $x, $y und getSignatureAppearanceArray().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

setSpacesRE (   $re = '/[^\S\xa0]/')

Set regular expression to detect withespaces or word separators. The pattern delimiter must be the forward-slash character "/". Some example patterns are:

Non-Unicode or missing PCRE unicode support: "/[^\S\xa0]/"
Unicode and PCRE unicode support: "/[^\S\P{Z}\xa0]/u"
Unicode and PCRE unicode support in Chinese mode: "/[^\S\P{Z}\P{Lo}\xa0]/u"
if PCRE unicode support is turned ON ("\P" is the negate class of "\p"):
"\p{Z}" or "\p{Separator}": any kind of Unicode whitespace or invisible separator.
"\p{Lo}" or "\p{Other_Letter}": a Unicode letter or ideograph that does not have lowercase and uppercase variants.
"\p{Lo}" is needed for Chinese characters because are packed next to each other without spaces in between.
Parameter
$re(string) regular expression (leave empty for default).
Seit
4.6.016 (2009-06-15)

Definiert in Zeile 2310 der Datei tcpdf.php.

Wird benutzt von __construct().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setSpotColor (   $type,
  $name,
  $tint = 100 
)

Set the spot color for the specified type ('draw', 'fill', 'text').

Parameter
$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).
Rückgabe
(string) PDF color command.
Seit
5.9.125 (2011-10-03)

Definiert in Zeile 3719 der Datei tcpdf.php.

Benutzt $TextColor, $xobjid, _out(), Error() und TCPDF_COLORS\getSpotColor().

Wird benutzt von setColor(), SetDrawSpotColor(), SetFillSpotColor() und SetTextSpotColor().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setSRGBmode (   $mode = false)

Set flag to force sRGB_IEC61966-2.1 black scaled ICC color profile for the whole document.

Parameter
$mode(boolean) If true force sRGB output intent.
Seit
5.9.121 (2011-09-28)

Definiert in Zeile 2832 der Datei tcpdf.php.

setStartingPageNumber (   $num = 1)

Set the starting page number.

Parameter
$num(int) Starting page number.
Seit
5.9.093 (2011-06-16)

Definiert in Zeile 13531 der Datei tcpdf.php.

SetSubject (   $subject)

Defines the subject of the document.

Parameter
$subject(string) The subject.
Seit
1.2
Siehe auch
SetAuthor(), SetCreator(), SetKeywords(), SetTitle()

Definiert in Zeile 2865 der Datei tcpdf.php.

Benutzt $subject.

setSVGStyles (   $svgstyle,
  $prevsvgstyle,
  $x = 0,
  $y = 0,
  $w = 1,
  $h = 1,
  $clip_function = '',
  $clip_params = array() 
)
protected

Apply the requested SVG styles (*** TO BE COMPLETED ***)

Parameter
$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
Rückgabe
object style
Autor
Nicola Asuni
Seit
5.0.000 (2010-05-02)

Definiert in Zeile 22995 der Datei tcpdf.php.

Benutzt TCPDF_COLORS\convertHTMLColorToDec().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

setTableHeader ( )
protected

This method is used to render the table header on new page (if any).

Seit
4.5.030 (2009-03-25)

Definiert in Zeile 3609 der Datei tcpdf.php.

Benutzt $cell_padding, $lMargin, $page, $rMargin, $tMargin, $y, TCPDF_STATIC\empty_string(), getGraphicVars(), setGraphicVars() und writeHTML().

Wird benutzt von startPage().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setTempRTL (   $mode)

Force temporary RTL language direction

Parameter
$mode(mixed) can be false, 'L' for LTR or 'R' for RTL
Seit
2.1.000 (2008-01-09)

Definiert in Zeile 2361 der Datei tcpdf.php.

Wird benutzt von openHTMLTagHandler().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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).
Rückgabe
(string) Empty string.
Seit
1.3
Siehe auch
SetTextColorArray(), SetDrawColor(), SetFillColor(), Text(), Cell(), MultiCell()

Definiert in Zeile 4003 der Datei tcpdf.php.

Benutzt setColor().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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.

Parameter
$color(array) Array of colors (1, 3 or 4 values).
$ret(boolean) If true do not send the PDF command.
Seit
3.1.000 (2008-6-11)
Siehe auch
SetFillColor()

Definiert in Zeile 3862 der Datei tcpdf.php.

Benutzt setColorArray().

Wird benutzt von addHtmlLink(), Cell(), Footer(), Header(), write1DBarcode() und writeHTML().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setTextRenderingMode (   $stroke = 0,
  $fill = true,
  $clip = false 
)

Set Text rendering mode.

Parameter
$stroke(int) outline size in user units (0 = disable).
$fill(boolean) if true fills the text (default).
$clip(boolean) if true activate clipping mode
Seit
4.9.008 (2009-04-02)

Definiert in Zeile 21818 der Datei tcpdf.php.

Wird benutzt von Close(), Text() und writeHTML().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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.
Seit
5.9.174 (2012-07-25)

Definiert in Zeile 21873 der Datei tcpdf.php.

Wird benutzt von __construct().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

SetTextSpotColor (   $name,
  $tint = 100 
)

Defines the spot color used for text.

Parameter
$name(string) Name of the spot color.
$tint(int) Intensity of the color (from 0 to 100 ; 100 = full intensity by default).
Seit
4.0.024 (2008-09-12)
Siehe auch
AddSpotColor(), SetDrawSpotColor(), SetFillSpotColor()

Definiert in Zeile 3789 der Datei tcpdf.php.

Benutzt setSpotColor().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

SetTitle (   $title)

Defines the title of the document.

Parameter
$title(string) The title.
Seit
1.2
Siehe auch
SetAuthor(), SetCreator(), SetKeywords(), SetSubject()

Definiert in Zeile 2854 der Datei tcpdf.php.

Benutzt $title.

SetTopMargin (   $margin)

Defines the top margin. The method can be called before creating the first page.

Parameter
$margin(float) The margin.
Seit
1.5
Siehe auch
SetLeftMargin(), SetRightMargin(), SetAutoPageBreak(), SetMargins()

Definiert in Zeile 2585 der Datei tcpdf.php.

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

Parameter
$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.
Autor
Nicola Asuni
Seit
2.9.000 (2008-03-26)

Definiert in Zeile 13385 der Datei tcpdf.php.

Benutzt setSignature().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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
    This entry is meaningful only if the value of the PageMode entry in the catalog dictionary (see Section 3.6.1, "Document Catalog") is FullScreen; it is ignored otherwise. Default value: UseNone.
  • 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
    Default value: none
  • 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
Parameter
$preferences(array) array of options.
Autor
Nicola Asuni
Seit
3.1.000 (2008-06-09)

Definiert in Zeile 13968 der Datei tcpdf.php.

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.

Parameter
$v(string) visibility mode. Legal values are: all, print, screen or view.
Seit
3.0.000 (2008-03-27)

Definiert in Zeile 13721 der Datei tcpdf.php.

Benutzt _out(), endLayer(), Error() und startLayer().

Wird benutzt von _endpage().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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).

Parameter
$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.
Seit
1.2
Siehe auch
GetX(), GetY(), SetY(), SetXY()

Definiert in Zeile 7412 der Datei tcpdf.php.

Benutzt $w und $x.

Wird benutzt von Footer(), Header(), MultiCell() und SetXY().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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.
Seit
1.2
Siehe auch
SetX(), SetY()

Definiert in Zeile 7478 der Datei tcpdf.php.

Benutzt $x, $y, SetX() und SetY().

Wird benutzt von openHTMLTagHandler(), setFooter(), setHeader() und Text().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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.
Seit
1.0
Siehe auch
GetX(), GetY(), SetY(), SetXY()

Definiert in Zeile 7445 der Datei tcpdf.php.

Benutzt $h, $lMargin, $rMargin und $y.

Wird benutzt von Footer(), Header(), Image(), ImageEps(), MultiCell(), setPage(), SetXY(), startPage(), write1DBarcode() und write2DBarcode().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

Skew (   $angle_x,
  $angle_y,
  $x = '',
  $y = '' 
)

Skew.

Parameter
$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
Seit
2.1.000 (2008-01-07)
Siehe auch
StartTransform(), StopTransform()

Definiert in Zeile 11238 der Datei tcpdf.php.

Benutzt $k, $x, $y, Error() und Transform().

Wird benutzt von SkewX() und SkewY().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

SkewX (   $angle_x,
  $x = '',
  $y = '' 
)

Skew horizontally.

Parameter
$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
Seit
2.1.000 (2008-01-07)
Siehe auch
StartTransform(), StopTransform()

Definiert in Zeile 11211 der Datei tcpdf.php.

Benutzt $x, $y und Skew().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

SkewY (   $angle_y,
  $x = '',
  $y = '' 
)

Skew vertically.

Parameter
$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
Seit
2.1.000 (2008-01-07)
Siehe auch
StartTransform(), StopTransform()

Definiert in Zeile 11224 der Datei tcpdf.php.

Benutzt $x, $y und Skew().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

sortBookmarks ( )
protected

Sort bookmarks for page and key.

Seit
5.9.119 (2011-09-19)

Definiert in Zeile 12359 der Datei tcpdf.php.

Wird benutzt von _putbookmarks().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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

Parameter
$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: If a key is not present or is null, not draws the side. Default value is default line style (empty array).
$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).
Seit
2.1.000 (2008-01-08)

Definiert in Zeile 12032 der Datei tcpdf.php.

Benutzt Circle() und Polygon().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

startLayer (   $name = '',
  $print = true,
  $view = true 
)

Start a new pdf layer.

Parameter
$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.
Seit
5.9.102 (2011-07-13)

Definiert in Zeile 13682 der Datei tcpdf.php.

Benutzt _out().

Wird benutzt von setVisibility().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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.
Seit
4.2.010 (2008-11-14)
Siehe auch
AddPage(), endPage(), addTOCPage(), endTOCPage(), getPageSizeFromFormat(), setPageFormat()

Definiert in Zeile 3139 der Datei tcpdf.php.

Benutzt $dests, $links, $numpages, $outlines, $page, $tocpage, _beginpage(), getGraphicVars(), Open(), setGraphicVars(), setHeader(), setPage(), setPageMark(), setTableHeader(), SetY() und swapMargins().

Wird benutzt von AddPage().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

startPageGroup (   $page = '')

Create a new page group. NOTE: call this function before calling AddPage()

Parameter
$page(int) starting group page (leave empty for next page).
Seit
3.0.000 (2008-03-27)

Definiert in Zeile 13518 der Datei tcpdf.php.

Benutzt $newpagegroup und $page.

startSVGElementHandler (   $parser,
  $name,
  $attribs,
  $ctm = array() 
)
protected

Sets the opening SVG element handler function for the XML parser. (*** TO BE COMPLETED ***)

Parameter
$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).
Autor
Nicola Asuni
Seit
5.0.000 (2010-05-02)

Definiert in Zeile 23641 der Datei tcpdf.php.

Benutzt $_SERVER, TCPDF_IMAGES\$svginheritprop, TCPDF_COLORS\convertHTMLColorToDec(), TCPDF_STATIC\empty_string(), TCPDF_IMAGES\getImageFileType(), TCPDF_STATIC\getSVGTransformMatrix() und TCPDF_STATIC\getTransformationMatrixProduct().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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.

Parameter
$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).
Rückgabe
int the XObject Template ID in case of success or false in case of error.
Autor
Nicola Asuni
Seit
5.8.017 (2010-08-24)
Siehe auch
endTemplate(), printTemplate()

Definiert in Zeile 22188 der Datei tcpdf.php.

Wird benutzt von Button(), Header() und TextField().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

startTransaction ( )

Stores a copy of the current TCPDF object used for undo operation.

Seit
4.5.029 (2009-03-19)

Definiert in Zeile 21595 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\objclone().

Wird benutzt von writeHTML().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Seit
2.1.000 (2008-01-07)
Siehe auch
StartTransform(), StopTransform()

Definiert in Zeile 10967 der Datei tcpdf.php.

Benutzt $page, $transfmatrix_key, $xobjid und _outSaveGraphicsState().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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.

Seit
2.1.000 (2008-01-07)
Siehe auch
StartTransform(), StopTransform()

Definiert in Zeile 10990 der Datei tcpdf.php.

Benutzt $transfmatrix_key und _outRestoreGraphicsState().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

stringLeftTrim (   $str,
  $replace = '' 
)

Left trim the input string

Parameter
$str(string) string to trim
$replace(string) string that replace spaces.
Rückgabe
left trimmed string
Autor
Nicola Asuni
Seit
5.8.000 (2010-08-11)

Definiert in Zeile 22094 der Datei tcpdf.php.

Wird benutzt von writeHTML().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

stringRightTrim (   $str,
  $replace = '' 
)

Right trim the input string

Parameter
$str(string) string to trim
$replace(string) string that replace spaces.
Rückgabe
right trimmed string
Autor
Nicola Asuni
Seit
5.8.000 (2010-08-11)

Definiert in Zeile 22107 der Datei tcpdf.php.

Wird benutzt von Write() und writeHTML().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

stringTrim (   $str,
  $replace = '' 
)

Trim the input string

Parameter
$str(string) string to trim
$replace(string) string that replace spaces.
Rückgabe
trimmed string
Autor
Nicola Asuni
Seit
5.8.000 (2010-08-11)

Definiert in Zeile 22120 der Datei tcpdf.php.

Wird benutzt von _putbookmarks(), getHtmlDomArray() und Write().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

SVGPath (   $d,
  $style = '' 
)
protected

Draws an SVG path

Parameter
$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).
Rückgabe
array of container box measures (x, y, w, h)
Autor
Nicola Asuni
Seit
5.0.000 (2010-05-02)

Definiert in Zeile 23279 der Datei tcpdf.php.

Benutzt TCPDF_STATIC\getPathPaintOperator() und TCPDF_STATIC\getVectorsAngle().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

SVGTransform (   $tm)
protected

Apply SVG graphic transformation matrix.

Parameter
$tm(array) original SVG transformation matrix
Seit
5.0.000 (2010-05-02)

Definiert in Zeile 22976 der Datei tcpdf.php.

swapMargins (   $reverse = true)
protected

Swap the left and right margins.

Parameter
$reverse(boolean) if true swap left and right margins.
Seit
4.2.000 (2008-10-29)

Definiert in Zeile 20067 der Datei tcpdf.php.

Wird benutzt von startPage().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
$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
or a string containing some or all of the following characters (in any order):
  • L: left
  • T: top
  • R: right
  • B: bottom
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)))
$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
Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
$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
General font stretching and scaling values will be preserved when possible.
$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.
Seit
1.0
Siehe auch
Cell(), Write(), MultiCell(), WriteHTML(), WriteHTMLCell()

Definiert in Zeile 4900 der Datei tcpdf.php.

Benutzt $textrendermode, $textstrokewidth, $x, $y, Cell(), setTextRenderingMode() und SetXY().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

TextField (   $name,
  $w,
  $h,
  $prop = array(),
  $opt = array(),
  $x = '',
  $y = '',
  $js = false 
)

Creates a text field

Parameter
$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).
Autor
Nicola Asuni
Seit
4.8.000 (2009-09-07)

Definiert in Zeile 12655 der Datei tcpdf.php.

Benutzt $h, $n, $w, $x, $y, _addfield(), Annotation(), checkPageRegions(), endTemplate(), TCPDF_STATIC\getAnnotOptFromJSProp(), getFormDefaultProp(), MultiCell() und startTemplate().

Wird benutzt von openHTMLTagHandler().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

Transform (   $tm)
protected

Apply graphic transformations.

Parameter
$tm(array) transformation matrix
Seit
2.1.000 (2008-01-07)
Siehe auch
StartTransform(), StopTransform()

Definiert in Zeile 11269 der Datei tcpdf.php.

Benutzt $page, $transfmatrix_key, $xobjid und _out().

Wird benutzt von Rotate(), Scale(), Skew() und Translate().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

Translate (   $t_x,
  $t_y 
)

Translate graphic object horizontally and vertically.

Parameter
$t_x(int) movement to the right
$t_y(int) movement to the bottom
Seit
2.1.000 (2008-01-07)
Siehe auch
StartTransform(), StopTransform()

Definiert in Zeile 11159 der Datei tcpdf.php.

Benutzt $k und Transform().

Wird benutzt von TranslateX() und TranslateY().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

TranslateX (   $t_x)

Translate graphic object horizontally.

Parameter
$t_x(int) movement to the right (or left for RTL)
Seit
2.1.000 (2008-01-07)
Siehe auch
StartTransform(), StopTransform()

Definiert in Zeile 11136 der Datei tcpdf.php.

Benutzt Translate().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

TranslateY (   $t_y)

Translate graphic object vertically.

Parameter
$t_y(int) movement to the bottom
Seit
2.1.000 (2008-01-07)
Siehe auch
StartTransform(), StopTransform()

Definiert in Zeile 11147 der Datei tcpdf.php.

Benutzt Translate().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

unhtmlentities (   $text_to_convert)

Reverse function for htmlentities. Convert entities in UTF-8.

Parameter
$text_to_convert(string) Text to convert.
Rückgabe
string converted text string

Definiert in Zeile 10447 der Datei tcpdf.php.

Wird benutzt von _putannotsobjs(), _putbookmarks() und getHtmlDomArray().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

unichr (   $c)

Returns the unicode caracter specified by the value

Parameter
$c(int) UTF-8 value
Rückgabe
Returns the specified character.
Seit
2.3.000 (2008-03-05)
Veraltet:

Definiert in Zeile 4153 der Datei tcpdf.php.

Benutzt TCPDF_FONTS\unichr().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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.

Parameter
$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
General font stretching and scaling values will be preserved when possible.
$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
Rückgabe
mixed Return the number of cells or the remaining string if $firstline = true.
Seit
1.5

Definiert in Zeile 6264 der Datei tcpdf.php.

Benutzt $cell_margin, $cell_padding, $h, $l, $lMargin, $page, $rMargin, 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() und TCPDF_FONTS\UTF8StringToArray().

Wird benutzt von addHtmlLink(), MultiCell() und writeHTML().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

write1DBarcode (   $code,
  $type,
  $x = '',
  $y = '',
  $w = '',
  $h = '',
  $xres = '',
  $style = '',
  $align = '' 
)

Print a Linear Barcode.

Parameter
$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
Autor
Nicola Asuni
Seit
3.1.000 (2008-06-09)

Definiert in Zeile 15154 der Datei tcpdf.php.

Benutzt $cell_padding, $h, $img_rb_x, $img_rb_y, $k, $lMargin, $rtl, $w, $x, $y, Cell(), checkPageRegions(), TCPDF_STATIC\empty_string(), Error(), fitBlock(), getCellHeight(), getGraphicVars(), GetStringWidth(), Rect(), SetCellPadding(), SetDrawColorArray(), SetFont(), setGraphicVars(), SetTextColorArray() und SetY().

Wird benutzt von Footer().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

write2DBarcode (   $code,
  $type,
  $x = '',
  $y = '',
  $w = '',
  $h = '',
  $style = '',
  $align = '',
  $distort = false 
)

Print 2D Barcode.

Parameter
$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
Autor
Nicola Asuni
Seit
4.5.037 (2009-04-07)

Definiert in Zeile 15473 der Datei tcpdf.php.

Benutzt $bMargin, $h, $img_rb_x, $img_rb_y, $lMargin, $rtl, $w, $x, $y, checkPageRegions(), TCPDF_STATIC\empty_string(), Error(), fitBlock(), getGraphicVars(), Rect(), SetDrawColorArray(), setGraphicVars() und SetY().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

writeDiskCache (   $filename,
  $data,
  $append = false 
)
protected

Writes data to a temporary file on filesystem.

Parameter
$filename(string) file name
$data(mixed) data to write on file
$append(boolean) if true append data, false replace.
Seit
4.5.000 (2008-12-31)

Definiert in Zeile 20568 der Datei tcpdf.php.

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.

Parameter
$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

Definiert in Zeile 17049 der Datei tcpdf.php.

Benutzt $cell_height_ratio, $cell_margin, $cell_padding, $current_column, $customlistindent, $feps, $font_spacing, $font_stretching, $FontFamily, $FontSize, $FontSizePt, $FontStyle, $k, $lasth, $lispacer, $listcount, $listnum, $listordered, $lMargin, $newline, $numpages, $page, $rMargin, $rtl, $textindent, $textstrokewidth, $thead, $w, $wPt, $x, $xobjid, $y, addHtmlLink(), checkPageBreak(), closeHTMLTagHandler(), TCPDF_STATIC\empty_string(), Error(), 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() und Write().

Wird benutzt von MultiCell() und setTableHeader().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.
Parameter
$w(float) Cell width. If 0, the cell extends up to the right margin.
$h(float) Cell minimum height. The cell extends automatically if needed.
$x(float) upper-left corner X coordinate
$y(float) upper-left corner Y coordinate
$html(string) html text to print. Default value: empty string.
$border(mixed) Indicates if borders must be drawn around the cell. The value can be a number:
  • 0: no border (default)
  • 1: frame
or a string containing some or all of the following characters (in any order):
  • L: left
  • T: top
  • R: right
  • B: bottom
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)))
$ln(int) Indicates where the current position should go after the call. Possible values are:
  • 0: to the right (or left for RTL language)
  • 1: to the beginning of the next line
  • 2: below
Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
$fill(boolean) Indicates if the cell background must be painted (true) or transparent (false).
$reseth(boolean) if true reset the last cell height (default true).
$align(string) Allows to center or align the text. Possible values are:
  • 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.
Siehe auch
Multicell(), writeHTML()

Definiert in Zeile 17032 der Datei tcpdf.php.

Benutzt $h, $w, $x, $y und MultiCell().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Dokumentation der Datenelemente

$alpha = array('CA' => 1, 'ca' => 1, 'BM' => '/Normal', 'AIS' => false)
protected

Alpha mode array. (Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).

Seit
5.9.152 (2012-03-23)

Definiert in Zeile 1788 der Datei tcpdf.php.

Wird benutzt von _outellipticalarc(), Cell(), getAlpha() und ImagePngAlpha().

$annotation_fonts = array()
protected

List of fonts used on form fields (fontname => fontkey).

Seit
4.8.001 (2009-09-09)

Definiert in Zeile 1366 der Datei tcpdf.php.

$author = ''
protected

Document author.

Definiert in Zeile 500 der Datei tcpdf.php.

Wird benutzt von SetAuthor().

$AutoPageBreak
protected

Automatic page breaking.

Definiert in Zeile 446 der Datei tcpdf.php.

Wird benutzt von AcceptPageBreak(), getAutoPageBreak() und setPageOrientation().

$barcode = false
protected

Barcode to print on page footer (only if set).

Definiert in Zeile 619 der Datei tcpdf.php.

Wird benutzt von Footer() und getBarcode().

$bgcolor
protected

Current background color.

Definiert in Zeile 752 der Datei tcpdf.php.

Wird benutzt von Cell().

$bMargin
protected

Page break margin.

Definiert in Zeile 274 der Datei tcpdf.php.

Wird benutzt von getBreakMargin(), MultiCell(), setPageOrientation() und write2DBarcode().

$booklet = false
protected

Booklet mode for double-sided pages.

Seit
4.2.000 (2008-10-29)

Definiert in Zeile 1085 der Datei tcpdf.php.

$bordermrk = array()
protected

Array used to store positions inside the pages buffer (keys are the page numbers).

Seit
5.7.000 (2010-08-03)

Definiert in Zeile 959 der Datei tcpdf.php.

$buffer
protected

Buffer holding in-memory PDF.

Definiert in Zeile 166 der Datei tcpdf.php.

Wird benutzt von getPDFData().

$bufferlen = 0
protected

Length of the buffer in bytes.

Seit
4.5.000 (2008-12-31)

Definiert in Zeile 1184 der Datei tcpdf.php.

Wird benutzt von _enddoc() und _getobj().

$cache_file_length = array()
protected

Array used to store the lengths of cache files.

Seit
4.5.029 (2009-03-19)

Definiert in Zeile 1240 der Datei tcpdf.php.

$cached_files = array()
protected

Array of cached files.

Definiert in Zeile 348 der Datei tcpdf.php.

$cell_height_ratio = K_CELL_HEIGHT_RATIO
protected

Default cell height ratio.

Seit
3.0.014 (2008-05-23)

Definiert in Zeile 924 der Datei tcpdf.php.

Wird benutzt von getCellHeight(), getCellHeightRatio(), getHtmlDomArray() und writeHTML().

$cell_margin = array('T' => 0, 'R' => 0, 'B' => 0, 'L' => 0)
protected

Array of cell margins ('T' => top, 'R' => right, 'B' => bottom, 'L' => left).

Seit
5.9.000 (2010-10-04)

Definiert in Zeile 288 der Datei tcpdf.php.

Wird benutzt von Cell(), getCellCode(), getCellMargins(), getCSSMargin(), getHtmlDomArray(), MultiCell(), Write() und writeHTML().

$cell_padding = array('T' => 0, 'R' => 0, 'B' => 0, 'L' => 0)
protected

Array of cell internal paddings ('T' => top, 'R' => right, 'B' => bottom, 'L' => left).

Seit
5.9.000 (2010-10-03)

Definiert in Zeile 281 der Datei tcpdf.php.

Wird benutzt von adjustCellPadding(), Cell(), getCellCode(), getCellPaddings(), getCSSPadding(), getHtmlDomArray(), getNumLines(), getStringHeight(), MultiCell(), openHTMLTagHandler(), setTableHeader(), Write(), write1DBarcode() und writeHTML().

$check_page_regions = true
protected

Boolean value true when page region check is active.

Definiert in Zeile 1554 der Datei tcpdf.php.

Wird benutzt von MultiCell().

$clMargin
protected

Cell left margin (used by regions).

Definiert in Zeile 256 der Datei tcpdf.php.

$cntmrk = array()
protected

Array used to store content positions inside the pages buffer (keys are the page numbers).

Seit
4.6.021 (2009-07-20)

Definiert in Zeile 973 der Datei tcpdf.php.

$ColorFlag
protected

Indicates whether fill and text colors are different.

Definiert in Zeile 440 der Datei tcpdf.php.

$column_start_page = 0
protected

Starting page for columns.

Seit
4.9.001 (2010-03-28)

Definiert in Zeile 1436 der Datei tcpdf.php.

$columns = array()
protected

Array of column measures (width, space, starting Y position).

Seit
4.9.001 (2010-03-28)

Definiert in Zeile 1415 der Datei tcpdf.php.

$colxshift = array('x' => 0, 's' => array('H' => 0, 'V' => 0), 'p' => array('L' => 0, 'T' => 0, 'R' => 0, 'B' => 0))
protected

Array of: X difference between table cell x start and starting page margin, cellspacing, cellpadding.

Seit
5.8.000 (2010-08-11)

Definiert in Zeile 1450 der Datei tcpdf.php.

$compress
protected

Compression flag.

Definiert in Zeile 184 der Datei tcpdf.php.

Wird benutzt von _putimages(), _putpages(), _puttruetypeunicode() und SetCompression().

$CoreFonts
protected

Array of standard font names.

Definiert in Zeile 318 der Datei tcpdf.php.

$creator = ''
protected

Document creator.

Definiert in Zeile 512 der Datei tcpdf.php.

Wird benutzt von SetCreator().

$crMargin
protected

Cell right margin (used by regions).

Definiert in Zeile 262 der Datei tcpdf.php.

$CurOrientation
protected

Current page orientation (P = Portrait, L = Landscape).

Definiert in Zeile 190 der Datei tcpdf.php.

Wird benutzt von _beginpage() und setPageOrientation().

$current_column = 0
protected

Current column number.

Seit
4.9.001 (2010-03-28)

Definiert in Zeile 1429 der Datei tcpdf.php.

Wird benutzt von MultiCell() und writeHTML().

$CurrentFont
protected

Current font info.

Definiert in Zeile 404 der Datei tcpdf.php.

$currpagegroup = 0
protected

Current page group number.

Seit
3.0.000 (2008-03-27)

Definiert in Zeile 903 der Datei tcpdf.php.

Wird benutzt von _beginpage() und getGroupPageNo().

$custom_xmp = ''
protected

Custom XMP data.

Seit
5.9.128 (2011-10-06)

Definiert in Zeile 1772 der Datei tcpdf.php.

Wird benutzt von _putXMP().

$customlistindent = -1
protected

HTML PARSER: custom indent amount for lists. Negative value means disabled.

Seit
4.2.007 (2008-11-12)

Definiert in Zeile 1106 der Datei tcpdf.php.

Wird benutzt von writeHTML().

$default_form_prop = array('lineWidth'=>1, 'borderStyle'=>'solid', 'fillColor'=>array(255, 255, 255), 'strokeColor'=>array(128, 128, 128))
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.

Seit
4.8.000 (2009-09-07)

Definiert in Zeile 1331 der Datei tcpdf.php.

Wird benutzt von getFormDefaultProp().

$default_graphic_vars = array()
protected

Array of default graphic settings.

Seit
5.5.008 (2010-07-02)

Definiert in Zeile 1505 der Datei tcpdf.php.

$default_monospaced_font = 'courier'
protected

Default monospace font.

Seit
4.5.025 (2009-03-10)

Definiert in Zeile 1226 der Datei tcpdf.php.

Wird benutzt von getHtmlDomArray().

$default_table_columns = 4
protected

Default number of columns for html table.

Definiert in Zeile 696 der Datei tcpdf.php.

$dests = array()
protected

A dictionary of names and corresponding destinations (Dests key on document Catalog).

Seit
5.9.097 (2011-06-23)

Definiert in Zeile 1568 der Datei tcpdf.php.

Wird benutzt von getDestination() und startPage().

$diffs = array()
protected

Array of encoding differences.

Definiert in Zeile 336 der Datei tcpdf.php.

$diskcache = false
protected

If true enables disk caching.

Seit
4.5.000 (2008-12-31)

Definiert in Zeile 1191 der Datei tcpdf.php.

Wird benutzt von __construct().

$doc_creation_timestamp
protected

Document creation date-time

Seit
5.9.152 (2012-03-22)

Definiert in Zeile 1758 der Datei tcpdf.php.

Wird benutzt von __construct(), _datestring() und getDocCreationTimestamp().

$doc_modification_timestamp
protected

Document modification date-time

Seit
5.9.152 (2012-03-22)

Definiert in Zeile 1765 der Datei tcpdf.php.

Wird benutzt von getDocModificationTimestamp().

$docinfounicode = true
protected

If true set the document information dictionary in Unicode.

Definiert in Zeile 482 der Datei tcpdf.php.

$dpi = 72
protected

DPI (Dot Per Inch) Document Resolution (do not change).

Seit
3.0.000 (2008-03-27)

Definiert in Zeile 882 der Datei tcpdf.php.

Wird benutzt von Image(), ImagePngAlpha() und setPageUnit().

$DrawColor
protected

Commands for drawing color.

Definiert in Zeile 422 der Datei tcpdf.php.

$efnames = array()
protected

Embedded Files Names

Seit
5.9.204 (2013-01-23)

Definiert in Zeile 1582 der Datei tcpdf.php.

$embeddedfiles = array()
protected

Array of files to embedd.

Seit
4.4.000 (2008-12-07)

Definiert in Zeile 1120 der Datei tcpdf.php.

$empty_signature_appearance = array()
protected

Array of empty digital signature appearances.

Seit
5.9.101 (2011-07-06)

Definiert in Zeile 1289 der Datei tcpdf.php.

$emptypagemrk = array()
protected

Array used to store page positions to track empty pages (keys are the page numbers).

Seit
5.8.007 (2010-08-18)

Definiert in Zeile 966 der Datei tcpdf.php.

$encoding = 'UTF-8'
protected

Default encoding.

Seit
1.53.0.TC010

Definiert in Zeile 771 der Datei tcpdf.php.

Wird benutzt von __construct().

$encryptdata = array()
protected

Array containing encryption settings.

Seit
5.0.005 (2010-05-11)

Definiert in Zeile 808 der Datei tcpdf.php.

$encrypted
protected

IBoolean flag indicating whether document is protected.

Seit
2.0.000 (2008-01-02)

Definiert in Zeile 801 der Datei tcpdf.php.

Wird benutzt von _putXMP().

$endlinex = 0
protected

End position of the latest inserted line.

Seit
3.2.000 (2008-07-01)

Definiert in Zeile 1001 der Datei tcpdf.php.

$epsmarker = 'x#!#EPS#!#x'
protected

String used to mark the beginning and end of EPS image blocks.

Seit
4.1.000 (2008-10-18)

Definiert in Zeile 1064 der Datei tcpdf.php.

$extgstates
protected

Array of transparency objects and parameters.

Seit
3.0.000 (2008-03-27)

Definiert in Zeile 910 der Datei tcpdf.php.

$feps = 0.005
protected

Epsilon value used for float calculations.

Seit
4.2.000 (2008-10-29)

Definiert in Zeile 1092 der Datei tcpdf.php.

Wird benutzt von writeHTML().

$fgcolor
protected

Current foreground color.

Definiert in Zeile 716 der Datei tcpdf.php.

Wird benutzt von addHtmlLink(), Cell() und getHtmlDomArray().

$fhPt
protected

Height of page format in points.

Definiert in Zeile 214 der Datei tcpdf.php.

Wird benutzt von setPageOrientation().

$file_id
protected

File ID (used on document trailer).

Seit
5.0.005 (2010-05-12)

Definiert in Zeile 829 der Datei tcpdf.php.

$FillColor
protected

Commands for filling color.

Definiert in Zeile 428 der Datei tcpdf.php.

$font_obj_ids = array()
protected

Store the font object IDs.

Seit
4.8.001 (2009-09-09)

Definiert in Zeile 1212 der Datei tcpdf.php.

$font_spacing = 0
protected

Increases or decreases the space between characters in a text by the specified amount (tracking).

Seit
5.9.000 (2010-09-29)

Definiert in Zeile 1540 der Datei tcpdf.php.

Wird benutzt von getCellCode(), GetCharWidth(), getHtmlDomArray() und writeHTML().

$font_stretching = 100
protected

Percentage of character stretching.

Seit
5.9.000 (2010-09-29)

Definiert in Zeile 1533 der Datei tcpdf.php.

Wird benutzt von getCellCode(), getHtmlDomArray() und writeHTML().

$font_subsetting = true
protected

Boolean flag: if true enables font subsetting by default.

Seit
5.3.002 (2010-06-07)

Definiert in Zeile 1498 der Datei tcpdf.php.

Wird benutzt von AddFont().

$FontAscent
protected

Current font ascent (distance between font top and baseline).

Seit
2.8.000 (2007-03-29)

Definiert in Zeile 379 der Datei tcpdf.php.

Wird benutzt von getCellCode().

$FontDescent
protected

Current font descent (distance between font bottom and baseline).

Seit
2.8.000 (2007-03-29)

Definiert in Zeile 386 der Datei tcpdf.php.

Wird benutzt von getCellCode().

$FontFamily
protected

Current font family.

Definiert in Zeile 366 der Datei tcpdf.php.

Wird benutzt von AddFont(), GetArrStringWidth(), getFontFamily(), getHtmlDomArray(), isCharDefined(), replaceMissingChars() und writeHTML().

$FontFiles = array()
protected

Array of font files.

Definiert in Zeile 330 der Datei tcpdf.php.

$fontkeys = array()
protected

Store the font keys.

Seit
4.5.000 (2009-01-02)

Definiert in Zeile 1205 der Datei tcpdf.php.

$fontlist = array()
protected

List of available fonts on filesystem.

Definiert in Zeile 710 der Datei tcpdf.php.

$fonts = array()
protected

Array of used fonts.

Definiert in Zeile 324 der Datei tcpdf.php.

$FontSize
protected

Current font size in user unit.

Definiert in Zeile 416 der Datei tcpdf.php.

Wird benutzt von getCellCode(), getFontSize() und writeHTML().

$FontSizePt
protected

Current font size in points.

Definiert in Zeile 410 der Datei tcpdf.php.

Wird benutzt von _dolinethroughw(), _dooverlinew(), _dounderlinew(), GetArrStringWidth(), getFontSizePt(), getHtmlDomArray(), MultiCell(), SetFont() und writeHTML().

$FontStyle
protected

Current font style.

Definiert in Zeile 372 der Datei tcpdf.php.

Wird benutzt von addHtmlLink(), GetArrStringWidth(), getFontStyle(), getHtmlDomArray() und writeHTML().

$footer_font
protected

Default font used on page footer.

Definiert in Zeile 607 der Datei tcpdf.php.

Wird benutzt von getFooterFont().

$footer_line_color = array(0,0,0)
protected

Color for footer line (RGB array).

Seit
5.9.174 (2012-07-25)

Definiert in Zeile 683 der Datei tcpdf.php.

$footer_margin
protected

Minimum distance between footer and bottom page margin.

Definiert in Zeile 581 der Datei tcpdf.php.

Wird benutzt von getFooterMargin() und setFooter().

$footer_text_color = array(0,0,0)
protected

Color for footer text (RGB array).

Seit
5.9.174 (2012-07-25)

Definiert in Zeile 676 der Datei tcpdf.php.

$footerlen = array()
protected

Array used to store footer length of each page.

Seit
4.0.014 (2008-07-29)

Definiert in Zeile 987 der Datei tcpdf.php.

$footerpos = array()
protected

Array used to store footer positions of each page.

Seit
3.2.000 (2008-07-01)

Definiert in Zeile 980 der Datei tcpdf.php.

$force_srgb = false
protected

If true force sRGB color profile for all document.

Seit
5.9.121 (2011-09-28)

Definiert in Zeile 1744 der Datei tcpdf.php.

$form_action = ''
protected

Current form action (used during XHTML rendering).

Seit
4.8.000 (2009-09-07)

Definiert in Zeile 1345 der Datei tcpdf.php.

Wird benutzt von openHTMLTagHandler().

$form_enctype = 'application/x-www-form-urlencoded'
protected

Current form encryption type (used during XHTML rendering).

Seit
4.8.000 (2009-09-07)

Definiert in Zeile 1352 der Datei tcpdf.php.

$form_mode = 'post'
protected

Current method to submit forms.

Seit
4.8.000 (2009-09-07)

Definiert in Zeile 1359 der Datei tcpdf.php.

$form_obj_id = array()
protected

List of form annotations IDs.

Seit
4.8.000 (2009-09-07)

Definiert in Zeile 1324 der Datei tcpdf.php.

$fwPt
protected

Width of page format in points.

Definiert in Zeile 208 der Datei tcpdf.php.

Wird benutzt von setPageOrientation().

$gdgammacache = array()
protected

Cache array for computed GD gamma values.

Seit
5.9.1632 (2012-06-05)

Definiert in Zeile 1809 der Datei tcpdf.php.

$gradients = array()
protected

Array for storing gradient information.

Seit
3.1.000 (2008-06-09)

Definiert in Zeile 945 der Datei tcpdf.php.

$header_font
protected

Default font used on page header.

Definiert in Zeile 601 der Datei tcpdf.php.

Wird benutzt von getHeaderFont().

$header_line_color = array(0,0,0)
protected

Color for header line (RGB array).

Seit
5.9.174 (2012-07-25)

Definiert in Zeile 669 der Datei tcpdf.php.

Wird benutzt von getHeaderData().

$header_logo = ''
protected

Header image logo.

Definiert in Zeile 637 der Datei tcpdf.php.

Wird benutzt von getHeaderData().

$header_logo_width = 30
protected

Width of header image logo in user units.

Definiert in Zeile 643 der Datei tcpdf.php.

Wird benutzt von getHeaderData().

$header_margin
protected

Minimum distance between header and top page margin.

Definiert in Zeile 575 der Datei tcpdf.php.

Wird benutzt von getHeaderMargin() und Header().

$header_string = ''
protected

String to pring on page header after title.

Definiert in Zeile 655 der Datei tcpdf.php.

Wird benutzt von getHeaderData().

$header_text_color = array(0,0,0)
protected

Color for header text (RGB array).

Seit
5.9.174 (2012-07-25)

Definiert in Zeile 662 der Datei tcpdf.php.

Wird benutzt von getHeaderData().

$header_title = ''
protected

Title to be printed on default page header.

Definiert in Zeile 649 der Datei tcpdf.php.

Wird benutzt von getHeaderData().

$header_xobj_autoreset = false
protected

If true reset the Header Xobject template at each page

Definiert in Zeile 569 der Datei tcpdf.php.

$header_xobjid = false
protected

ID of the stored default header template (-1 = not set).

Definiert in Zeile 563 der Datei tcpdf.php.

$hPt
protected

Current height of page in points.

Definiert in Zeile 226 der Datei tcpdf.php.

Wird benutzt von setPageOrientation().

$HREF = array()
protected

HTML PARSER: array to store current link and rendering styles.

Definiert in Zeile 704 der Datei tcpdf.php.

$htmlLinkColorArray = array(0, 0, 255)
protected

Default color for html links.

Seit
4.4.003 (2008-12-09)

Definiert in Zeile 1142 der Datei tcpdf.php.

Wird benutzt von getHtmlDomArray().

$htmlLinkFontStyle = 'U'
protected

Default font style to add to html links.

Seit
4.4.003 (2008-12-09)

Definiert in Zeile 1149 der Datei tcpdf.php.

Wird benutzt von getHtmlDomArray().

$htmlvspace = 0
protected

Count the latest inserted vertical spaces on HTML.

Seit
4.0.021 (2008-08-24)

Definiert in Zeile 1043 der Datei tcpdf.php.

$imagekeys = array()
protected

Store the image keys.

Seit
4.5.000 (2008-12-31)

Definiert in Zeile 1177 der Datei tcpdf.php.

$images = array()
protected

Array of used images.

Definiert in Zeile 342 der Datei tcpdf.php.

$img_rb_x
protected

The right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image.

Seit
2002-07-31
Autor
Nicola Asuni

Definiert in Zeile 526 der Datei tcpdf.php.

Wird benutzt von getImageRBX(), Image(), ImageEps(), write1DBarcode() und write2DBarcode().

$img_rb_y
protected

The right-bottom corner Y coordinate of last inserted image.

Seit
2002-07-31
Autor
Nicola Asuni

Definiert in Zeile 534 der Datei tcpdf.php.

Wird benutzt von getImageRBY(), Image(), ImageEps(), write1DBarcode() und write2DBarcode().

$imgscale = 1
protected

Adjusting factor to convert pixels to user units.

Seit
2004-06-14
Autor
Nicola Asuni

Definiert in Zeile 542 der Datei tcpdf.php.

Wird benutzt von getImageScale().

$InFooter = false
protected

Flag set when processing page footer.

Definiert in Zeile 464 der Datei tcpdf.php.

$InHeader = false
protected

Flag set when processing page header.

Definiert in Zeile 458 der Datei tcpdf.php.

$internal_encoding
protected

PHP internal encoding.

Seit
1.53.0.TC016

Definiert in Zeile 778 der Datei tcpdf.php.

$inthead = false
protected

True when we are printing the thead section on a new page.

Seit
4.8.027 (2010-01-25)

Definiert in Zeile 1408 der Datei tcpdf.php.

$intmrk = array()
protected

Array used to store positions inside the pages buffer (keys are the page numbers).

Seit
3.2.000 (2008-06-26)

Definiert in Zeile 952 der Datei tcpdf.php.

$inxobj = false
protected

Boolean value true when we are inside an XObject.

Seit
5.8.017 (2010-08-24)

Definiert in Zeile 1519 der Datei tcpdf.php.

$isunicode = false
protected

Boolean flag set to true when the input text is unicode (require unicode fonts).

Seit
2005-01-02
Autor
Nicola Asuni

Definiert in Zeile 550 der Datei tcpdf.php.

Wird benutzt von _putinfo() und _putXMP().

$javascript = ''
protected

Javascript code.

Seit
2.1.002 (2008-02-12)

Definiert in Zeile 854 der Datei tcpdf.php.

$jpeg_quality
protected

Set the default JPEG compression quality (1-100).

Seit
3.0.000 (2008-03-27)

Definiert in Zeile 917 der Datei tcpdf.php.

$js_objects = array()
protected

Javascript objects array.

Seit
4.8.000 (2009-09-07)

Definiert in Zeile 1338 der Datei tcpdf.php.

$keywords = ''
protected

Document keywords.

Definiert in Zeile 506 der Datei tcpdf.php.

Wird benutzt von SetKeywords().

$l
protected

Language templates.

Definiert in Zeile 613 der Datei tcpdf.php.

Wird benutzt von _putannotsobjs(), _putbookmarks() und Write().

$last_enc_key
protected

Last RC4 key encrypted (cached for optimisation).

Seit
2.0.000 (2008-01-02)

Definiert in Zeile 815 der Datei tcpdf.php.

$last_enc_key_c
protected

Last RC4 computed key.

Seit
2.0.000 (2008-01-02)

Definiert in Zeile 822 der Datei tcpdf.php.

$lasth
protected

Height of last cell printed.

Definiert in Zeile 306 der Datei tcpdf.php.

Wird benutzt von getLastH(), getNumLines(), getStringHeight(), Ln(), setFooter(), setHeader() und writeHTML().

$LayoutMode
protected

Layout display mode.

Definiert in Zeile 476 der Datei tcpdf.php.

$linestyleCap = '0 J'
protected

PDF string for CAP value of the last line.

Seit
4.0.006 (2008-07-16)

Definiert in Zeile 1015 der Datei tcpdf.php.

$linestyleDash = '[] 0 d'
protected

PDF string for dash value of the last line.

Seit
4.0.006 (2008-07-16)

Definiert in Zeile 1029 der Datei tcpdf.php.

$linestyleJoin = '0 j'
protected

PDF string for join value of the last line.

Seit
4.0.006 (2008-07-16)

Definiert in Zeile 1022 der Datei tcpdf.php.

$linestyleWidth = ''
protected

PDF string for width value of the last line.

Seit
4.0.006 (2008-07-16)

Definiert in Zeile 1008 der Datei tcpdf.php.

$linethrough
protected

line through state

Seit
2.8.000 (2008-03-19)

Definiert in Zeile 868 der Datei tcpdf.php.

$LineWidth
protected

Line width in user unit.

Definiert in Zeile 312 der Datei tcpdf.php.

Wird benutzt von adjustCellPadding(), Arrow(), getCellBorder() und GetLineWidth().

$links = array()
protected

Array of internal links.

Definiert in Zeile 360 der Datei tcpdf.php.

Wird benutzt von startPage().

$lispacer = ''
protected

Spacer string for LI tags.

Definiert in Zeile 764 der Datei tcpdf.php.

Wird benutzt von writeHTML().

$listcount = array()
protected

HTML PARSER: array count list items on nested lists.

Definiert in Zeile 728 der Datei tcpdf.php.

Wird benutzt von writeHTML().

$listindent = 0
protected

HTML PARSER: indent amount for lists.

Definiert in Zeile 740 der Datei tcpdf.php.

Wird benutzt von openHTMLTagHandler().

$listindentlevel = 0
protected

HTML PARSER: current list indententation level.

Definiert in Zeile 746 der Datei tcpdf.php.

Wird benutzt von openHTMLTagHandler().

$listnum = 0
protected

HTML PARSER: current list nesting level.

Definiert in Zeile 734 der Datei tcpdf.php.

Wird benutzt von openHTMLTagHandler() und writeHTML().

$listordered = array()
protected

HTML PARSER: array of boolean values, true in case of ordered list (OL), false otherwise.

Definiert in Zeile 722 der Datei tcpdf.php.

Wird benutzt von writeHTML().

$lisymbol = ''
protected

Symbol used for HTML unordered list items.

Seit
4.0.028 (2008-09-26)

Definiert in Zeile 1057 der Datei tcpdf.php.

Wird benutzt von openHTMLTagHandler().

$maxselcol = array('page' => 0, 'column' => 0)
protected

Maximum page and column selected.

Seit
5.8.000 (2010-08-11)

Definiert in Zeile 1443 der Datei tcpdf.php.

$n_dests
protected

Object ID for Named Destinations

Seit
5.9.097 (2011-06-23)

Definiert in Zeile 1575 der Datei tcpdf.php.

$n_js
protected

Javascript counter.

Seit
2.1.002 (2008-02-12)

Definiert in Zeile 861 der Datei tcpdf.php.

$newline = true
protected

Boolean flag to indicate if a new line is created.

Seit
3.2.000 (2008-07-01)

Definiert in Zeile 994 der Datei tcpdf.php.

Wird benutzt von setHeader() und writeHTML().

$newpagegroup = array()
protected

Array of page numbers were a new page group was started (the page numbers are the keys of the array).

Seit
3.0.000 (2008-03-27)

Definiert in Zeile 889 der Datei tcpdf.php.

Wird benutzt von startPageGroup().

$num_columns = 1
protected

Number of colums.

Seit
4.9.001 (2010-03-28)

Definiert in Zeile 1422 der Datei tcpdf.php.

Wird benutzt von MultiCell().

$numfonts = 0
protected

Counts the number of fonts.

Seit
4.5.000 (2009-01-02)

Definiert in Zeile 1198 der Datei tcpdf.php.

Wird benutzt von AddFont().

$numimages = 0
protected

Counts the number of pages.

Seit
4.5.000 (2008-12-31)

Definiert in Zeile 1170 der Datei tcpdf.php.

$numpages = 0
protected

Counts the number of pages.

Seit
4.5.000 (2008-12-31)

Definiert in Zeile 1156 der Datei tcpdf.php.

Wird benutzt von _putannotsobjs(), _putpages(), getNumPages(), startPage() und writeHTML().

$objcopy
protected

Cloned copy of the current class object.

Seit
4.5.029 (2009-03-19)

Definiert in Zeile 1233 der Datei tcpdf.php.

$offsets = array()
protected

Array of object offsets.

Definiert in Zeile 154 der Datei tcpdf.php.

$opencell = true
protected

Boolean flag to indicate if the border of the cell sides that cross the page should be removed.

Seit
4.2.010 (2008-11-14)

Definiert in Zeile 1113 der Datei tcpdf.php.

$openMarkedContent = false
protected

Boolean flag to indicate if marked-content sequence is open.

Seit
4.0.013 (2008-07-28)

Definiert in Zeile 1036 der Datei tcpdf.php.

$original_lMargin
protected

Original left margin value.

Seit
1.53.0.TC013

Definiert in Zeile 588 der Datei tcpdf.php.

Wird benutzt von Header(), setFooter(), setHeader() und setPageOrientation().

$original_rMargin
protected

Original right margin value.

Seit
1.53.0.TC013

Definiert in Zeile 595 der Datei tcpdf.php.

Wird benutzt von Header(), setFooter(), setHeader() und setPageOrientation().

$OutlineRoot
protected

Outline root for bookmark.

Seit
2.1.002 (2008-02-12)

Definiert in Zeile 845 der Datei tcpdf.php.

$outlines = array()
protected

Outlines for bookmark.

Seit
2.1.002 (2008-02-12)

Definiert in Zeile 838 der Datei tcpdf.php.

Wird benutzt von startPage().

$overline
protected

Overlining flag.

Definiert in Zeile 398 der Datei tcpdf.php.

$overprint = array('OP' => false, 'op' => false, 'OPM' => 0)
protected

Overprint mode array. (Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).

Seit
5.9.152 (2012-03-23)

Definiert in Zeile 1780 der Datei tcpdf.php.

Wird benutzt von getOverprint().

$page_boxes = array('MediaBox', 'CropBox', 'BleedBox', 'TrimBox', 'ArtBox')
protected

Define the page boundaries boxes to be set on document.

Seit
5.9.152 (2012-03-23)

Definiert in Zeile 1795 der Datei tcpdf.php.

$page_obj_id = array()
protected

ID of page objects.

Seit
4.7.000 (2009-08-29)

Definiert in Zeile 1317 der Datei tcpdf.php.

$page_regions = array()
protected

Array of no-write regions. ('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)

Seit
5.9.003 (2010-10-14)

Definiert in Zeile 1548 der Datei tcpdf.php.

$PageAnnots = array()
protected

Array of Annotations in pages.

Definiert in Zeile 354 der Datei tcpdf.php.

$PageBreakTrigger
protected

Threshold used to trigger page breaks.

Definiert in Zeile 452 der Datei tcpdf.php.

Wird benutzt von fitBlock().

$pagedim = array()
protected

Page dimensions.

Definiert in Zeile 196 der Datei tcpdf.php.

$pagegroups = array()
protected

Array that contains the number of pages in each page group.

Seit
3.0.000 (2008-03-27)

Definiert in Zeile 896 der Datei tcpdf.php.

$pagelen = array()
protected

Array containing page lengths in bytes.

Seit
4.5.000 (2008-12-31)

Definiert in Zeile 1163 der Datei tcpdf.php.

Wird benutzt von _putpages().

$PageMode
protected

A name object specifying how the document should be displayed when opened.

Seit
3.1.000 (2008-06-09)

Definiert in Zeile 938 der Datei tcpdf.php.

$pageobjects = array()
protected

Array of object IDs for each page.

Definiert in Zeile 160 der Datei tcpdf.php.

$pageopen = array()
protected

Store the fage status (true when opened, false when closed).

Seit
4.5.000 (2009-01-02)

Definiert in Zeile 1219 der Datei tcpdf.php.

$pages = array()
protected

Array containing pages.

Definiert in Zeile 172 der Datei tcpdf.php.

$pdfa_mode = false
protected

If true set the document to PDF/A mode.

Seit
5.9.121 (2011-09-27)

Definiert in Zeile 1751 der Datei tcpdf.php.

$pdflayers = array()
protected

Array of PDF layers data.

Seit
5.9.102 (2011-07-13)

Definiert in Zeile 1561 der Datei tcpdf.php.

$pdfunit = 'mm'
protected

Default unit of measure for document.

Seit
5.0.000 (2010-04-22)

Definiert in Zeile 1478 der Datei tcpdf.php.

$PDFVersion = '1.7'
protected

PDF version.

Seit
1.5.3

Definiert in Zeile 557 der Datei tcpdf.php.

$premode = false
protected

Boolean flag to indicate if we are inside a PRE tag.

Seit
4.4.001 (2008-12-08)

Definiert in Zeile 1127 der Datei tcpdf.php.

$print_footer = true
protected

Boolean flag to print/hide page footer.

Definiert in Zeile 631 der Datei tcpdf.php.

$print_header = true
protected

Boolean flag to print/hide page header.

Definiert in Zeile 625 der Datei tcpdf.php.

$radio_groups = array()
protected

List of radio group objects IDs.

Seit
4.8.001 (2009-09-09)

Definiert in Zeile 1380 der Datei tcpdf.php.

$radiobutton_groups = array()
protected

List of radio buttons parent objects.

Seit
4.8.001 (2009-09-09)

Definiert in Zeile 1373 der Datei tcpdf.php.

$rasterize_vector_images = false
protected

Boolean flag: if true convert vector images (SVG, EPS) to raster image using GD or ImageMagick library.

Seit
5.0.000 (2010-04-26)

Definiert in Zeile 1491 der Datei tcpdf.php.

$re_space = array('p' => '[^\S\xa0]', 'm' => '')
protected

Array of $re_spaces parts.

Seit
5.5.011 (2010-07-09)

Definiert in Zeile 1303 der Datei tcpdf.php.

$re_spaces = '/[^\S\xa0]/'
protected

Regular expression used to find blank characters (required for word-wrapping).

Seit
4.6.006 (2009-04-28)

Definiert in Zeile 1296 der Datei tcpdf.php.

$rtl = false
protected

Boolean flag to indicate if the document language is Right-To-Left.

Seit
2.0.000

Definiert in Zeile 785 der Datei tcpdf.php.

Wird benutzt von getRTL(), write1DBarcode(), write2DBarcode() und writeHTML().

$sig_obj_id = 0
protected

Digital signature object ID.

Seit
4.6.022 (2009-06-23)

Definiert in Zeile 1310 der Datei tcpdf.php.

$sign = false
protected

Boolean flag to enable document digital signature.

Seit
4.6.005 (2009-04-24)

Definiert in Zeile 1261 der Datei tcpdf.php.

$signature_appearance = array('page' => 1, 'rect' => '0 0 0 0')
protected

Data for digital signature appearance.

Seit
5.3.011 (2010-06-16)

Definiert in Zeile 1282 der Datei tcpdf.php.

$signature_data = array()
protected

Digital signature data.

Seit
4.6.005 (2009-04-24)

Definiert in Zeile 1268 der Datei tcpdf.php.

$signature_max_length = 11742
protected

Digital signature max length.

Seit
4.6.005 (2009-04-24)

Definiert in Zeile 1275 der Datei tcpdf.php.

$spot_colors = array()
protected

Array of Spot colors.

Seit
4.0.024 (2008-09-12)

Definiert in Zeile 1050 der Datei tcpdf.php.

Wird benutzt von colorRegistrationBar() und getAllSpotColors().

$start_transaction_page = 0
protected

Store page number when startTransaction() is called.

Seit
4.8.006 (2009-09-23)

Definiert in Zeile 1394 der Datei tcpdf.php.

$start_transaction_y = 0
protected

Store Y position when startTransaction() is called.

Seit
4.9.001 (2010-03-28)

Definiert in Zeile 1401 der Datei tcpdf.php.

$starting_page_number = 1
protected

Starting page number.

Definiert in Zeile 518 der Datei tcpdf.php.

$state
protected

Current document state.

Definiert in Zeile 178 der Datei tcpdf.php.

$strokecolor
protected

Current stroke color.

Seit
4.9.008 (2010-04-03)

Definiert in Zeile 1471 der Datei tcpdf.php.

Wird benutzt von Cell() und getHtmlDomArray().

$subject = ''
protected

Document subject.

Definiert in Zeile 494 der Datei tcpdf.php.

Wird benutzt von SetSubject().

$svgclipid = 0
protected

ID of last SVG clipPath.

Seit
5.0.000 (2010-05-02)

Definiert in Zeile 1652 der Datei tcpdf.php.

$svgclipmode = false
protected

Boolean value true when in SVG clipPath tag.

Seit
5.0.000 (2010-04-26)

Definiert in Zeile 1631 der Datei tcpdf.php.

$svgclippaths = array()
protected

Array of SVG clipPath commands.

Seit
5.0.000 (2010-05-02)

Definiert in Zeile 1638 der Datei tcpdf.php.

$svgcliptm = array()
protected

Array of SVG clipPath tranformation matrix.

Seit
5.8.022 (2010-08-31)

Definiert in Zeile 1645 der Datei tcpdf.php.

$svgdefs = array()
protected

Array of SVG defs.

Seit
5.0.000 (2010-05-02)

Definiert in Zeile 1624 der Datei tcpdf.php.

$svgdefsmode = false
protected

Boolean value true when in SVG defs group.

Seit
5.0.000 (2010-05-02)

Definiert in Zeile 1617 der Datei tcpdf.php.

$svgdir = ''
protected

Directory used for the last SVG image.

Seit
5.0.000 (2010-05-05)

Definiert in Zeile 1589 der Datei tcpdf.php.

$svggradientid = 0
protected

ID of last SVG gradient.

Seit
5.0.000 (2010-05-02)

Definiert in Zeile 1610 der Datei tcpdf.php.

$svggradients = array()
protected

Array of SVG gradients.

Seit
5.0.000 (2010-05-02)

Definiert in Zeile 1603 der Datei tcpdf.php.

$svgstyles
protected

Array of SVG properties.

Seit
5.0.000 (2010-05-02)

Definiert in Zeile 1673 der Datei tcpdf.php.

$svgtext = ''
protected

SVG text.

Seit
5.0.000 (2010-05-02)

Definiert in Zeile 1659 der Datei tcpdf.php.

$svgtextmode = array()
protected

SVG text properties.

Seit
5.8.013 (2010-08-23)

Definiert in Zeile 1666 der Datei tcpdf.php.

$svgunit = 'px'
protected

Deafult unit of measure for SVG.

Seit
5.0.000 (2010-05-02)

Definiert in Zeile 1596 der Datei tcpdf.php.

$tagvspaces = array()
protected

Array used for custom vertical spaces for HTML tags.

Seit
4.2.001 (2008-10-30)

Definiert in Zeile 1099 der Datei tcpdf.php.

$tcpdflink = true
protected

If true print TCPDF meta link.

Seit
5.9.152 (2012-03-23)

Definiert in Zeile 1802 der Datei tcpdf.php.

$tempfontsize = 10
protected

Temporary font size in points.

Definiert in Zeile 758 der Datei tcpdf.php.

$TextColor
protected

Commands for text color.

Definiert in Zeile 434 der Datei tcpdf.php.

Wird benutzt von setColor() und setSpotColor().

$textindent = 0
protected

Text indentation value (used for text-indent CSS attribute).

Seit
4.8.006 (2009-09-23)

Definiert in Zeile 1387 der Datei tcpdf.php.

Wird benutzt von writeHTML().

$textrendermode = 0
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.

Seit
4.9.008 (2010-04-03)

Definiert in Zeile 1457 der Datei tcpdf.php.

Wird benutzt von Text().

$textstrokewidth = 0
protected

Text stroke width in doc units.

Seit
4.9.008 (2010-04-03)

Definiert in Zeile 1464 der Datei tcpdf.php.

Wird benutzt von getHtmlDomArray(), Text() und writeHTML().

$thead = ''
protected

Table header content to be repeated on each new page.

Seit
4.5.030 (2009-03-20)

Definiert in Zeile 1247 der Datei tcpdf.php.

Wird benutzt von getHtmlDomArray(), setFooter(), setHeader() und writeHTML().

$theadMargins = array()
protected

Margins used for table header.

Seit
4.5.030 (2009-03-20)

Definiert in Zeile 1254 der Datei tcpdf.php.

Wird benutzt von setFooter() und setHeader().

$title = ''
protected

Document title.

Definiert in Zeile 488 der Datei tcpdf.php.

Wird benutzt von _putbookmarks() und SetTitle().

$tMargin
protected

Top margin.

Definiert in Zeile 268 der Datei tcpdf.php.

Wird benutzt von _beginpage(), checkPageBreak(), fitBlock(), MultiCell(), setPageOrientation() und setTableHeader().

$tmprtl = false
protected

Boolean flag used to force RTL or LTR string direction.

Seit
2.0.000

Definiert in Zeile 792 der Datei tcpdf.php.

$tocpage = false
protected

Boolean flag true when we are on TOC (Table Of Content) page.

Definiert in Zeile 1484 der Datei tcpdf.php.

Wird benutzt von AddPage(), endPage() und startPage().

$transfmatrix = array()
protected

Array of transformation matrix.

Seit
4.2.000 (2008-10-29)

Definiert in Zeile 1071 der Datei tcpdf.php.

$transfmatrix_key = 0
protected

Current key for transformation matrix.

Seit
4.8.005 (2009-09-17)

Definiert in Zeile 1078 der Datei tcpdf.php.

Wird benutzt von StartTransform(), StopTransform() und Transform().

$transfmrk = array()
protected

Array used to store positions of graphics transformation blocks inside the page buffer. keys are the page numbers

Seit
4.4.002 (2008-12-09)

Definiert in Zeile 1135 der Datei tcpdf.php.

$txtshadow = array('enabled'=>false, 'depth_w'=>0, 'depth_h'=>0, 'color'=>false, 'opacity'=>1, 'blend_mode'=>'Normal')
protected

Text shadow data array.

Seit
5.9.174 (2012-07-25)

Definiert in Zeile 690 der Datei tcpdf.php.

$underline
protected

Underlining flag.

Definiert in Zeile 392 der Datei tcpdf.php.

$ur = array()
protected

Array with additional document-wide usage rights for the document.

Seit
5.8.014 (2010-08-23)

Definiert in Zeile 875 der Datei tcpdf.php.

$viewer_preferences
protected

PDF viewer preferences.

Seit
3.1.000 (2008-06-09)

Definiert in Zeile 931 der Datei tcpdf.php.

Wird benutzt von _putviewerpreferences().

$wPt
protected

Current width of page in points.

Definiert in Zeile 220 der Datei tcpdf.php.

Wird benutzt von setPageOrientation() und writeHTML().

$xobjects = array()
protected

Array of XObjects.

Seit
5.8.014 (2010-08-23)

Definiert in Zeile 1512 der Datei tcpdf.php.

$xobjid = ''
protected

Current XObject ID.

Seit
5.8.017 (2010-08-24)

Definiert in Zeile 1526 der Datei tcpdf.php.

Wird benutzt von _out(), addExtGState(), AddFont(), Annotation(), CoonsPatchMesh(), Gradient(), Image(), MultiCell(), setSpotColor(), StartTransform(), Transform() und writeHTML().

$ZoomMode
protected

Zoom display mode.

Definiert in Zeile 470 der Datei tcpdf.php.


Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:




Korrekturen, Hinweise und Ergänzungen

Bitte scheuen Sie sich nicht und melden Sie, was auf dieser Seite sachlich falsch oder irreführend ist, was ergänzt werden sollte, was fehlt usw. Dazu bitte oben aus dem Menü Seite den Eintrag Support Forum wählen. Es ist eine kostenlose Anmeldung erforderlich, um Anmerkungen zu posten. Unpassende Postings, Spam usw. werden kommentarlos entfernt.