|
Moodle
2.2.1
http://www.collinsharper.com
|
|
Moodle
2.2.1
http://www.collinsharper.com
|
Public Member Functions | |
| __construct ($orientation='P', $unit='mm', $format='A4', $unicode=true, $encoding='UTF-8', $diskcache=false, $pdfa=false) | |
| __destruct () | |
| getTCPDFVersion () | |
| setPageUnit ($unit) | |
| getPageSizeFromFormat ($format) | |
| setPageBoxes ($page, $type, $llx, $lly, $urx, $ury, $points=false) | |
| setPageOrientation ($orientation, $autopagebreak='', $bottommargin='') | |
| setSpacesRE ($re='/[^\S\xa0]/') | |
| setRTL ($enable, $resetx=true) | |
| getRTL () | |
| setTempRTL ($mode) | |
| isRTLTextDir () | |
| setLastH ($h) | |
| 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='') | |
| getHeaderData () | |
| setHeaderMargin ($hm=10) | |
| getHeaderMargin () | |
| setFooterMargin ($fm=10) | |
| getFooterMargin () | |
| setPrintHeader ($val=true) | |
| setPrintFooter ($val=true) | |
| getImageRBX () | |
| getImageRBY () | |
| resetHeaderTemplate () | |
| setHeaderTemplateAutoreset ($val=true) | |
| Header () | |
| Footer () | |
| PageNo () | |
| AddSpotColor ($name, $c, $m, $y, $k) | |
| getSpotColor ($name) | |
| 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) | |
| AddFont ($family, $style='', $fontfile='', $subset='default') | |
| SetFont ($family, $style='', $size=0, $fontfile='', $subset='default', $out=true) | |
| SetFontSize ($size, $out=true) | |
| getFontDescent ($font, $style='', $size=0) | |
| getFontAscent ($font, $style='', $size=0) | |
| 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 () | |
| removeSHY ($txt='') | |
| 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='') | |
| UTF8ArrSubString ($strarr, $start='', $end='') | |
| UniArrSubString ($uniarr, $start='', $end='') | |
| UTF8ArrayToUniArray ($ta) | |
| unichr ($c) | |
| getImageFileType ($imgfile, $iminfo=array()) | |
| 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()) | |
| set_mqr ($mqr) | |
| get_mqr () | |
| Ln ($h='', $cell=false) | |
| GetX () | |
| GetAbsX () | |
| GetY () | |
| SetX ($x, $rtloff=false) | |
| SetY ($y, $resetx=true, $rtloff=false) | |
| SetXY ($x, $y, $rtloff=false) | |
| Output ($name='doc.pdf', $dest='I') | |
| _destroy ($destroyall=false, $preserve_objcopy=false) | |
| addTTFfont ($fontfile, $fonttype='', $enc='', $flags=32, $outpath='') | |
| setExtraXMP ($xmp) | |
| setHeaderFont ($font) | |
| getHeaderFont () | |
| setFooterFont ($font) | |
| getFooterFont () | |
| setLanguageArray ($language) | |
| getPDFData () | |
| addHtmlLink ($url, $name, $fill=false, $firstline=false, $color='', $style=-1, $firstblock=false) | |
| convertHTMLColorToDec ($hcolor='#FFFFFF', $defcol=array(128, 128, 128)) | |
| 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='') | |
| getDestination () | |
| setBookmark ($txt, $level=0, $y=-1, $page='', $style='', $color=array(0, 0, 0)) | |
| Bookmark ($txt, $level=0, $y=-1, $page='', $style='', $color=array(0, 0, 0)) | |
| 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) | |
| addEmptySignatureAppearance ($x=0, $y=0, $w=0, $h=0, $page=-1) | |
| startPageGroup ($page='') | |
| AliasNbPages ($s='') | |
| AliasNumPage ($s='') | |
| setStartingPageNumber ($num=1) | |
| getAliasRightShift () | |
| getAliasNbPages () | |
| getAliasNumPage () | |
| getPageGroupAlias () | |
| getPageNumGroupAlias () | |
| getGroupPageNo () | |
| getGroupPageNoFormatted () | |
| PageNoFormatted () | |
| startLayer ($name='', $print=true, $view=true) | |
| endLayer () | |
| setVisibility ($v) | |
| setAlpha ($alpha, $bm='Normal') | |
| 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='A, B, C, D', $color=array(0, 0, 0)) | |
| registrationMark ($x, $y, $r, $double=false, $cola=array(0, 0, 0), $colb=array(255, 255, 255)) | |
| 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='') | |
| writeBarcode ($x, $y, $w, $h, $type, $style, $font, $xres, $code) | |
| 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) | |
| 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) | |
| intToRoman ($number) | |
| 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) | |
| objclone ($object) | |
| empty_string ($str) | |
| revstrpos ($haystack, $needle, $offset=0) | |
| setEqualColumns ($numcols=0, $width=0, $y='') | |
| resetColumns () | |
| setColumnsArray ($columns) | |
| selectColumn ($col='') | |
| getColumn () | |
| getNumberOfColumns () | |
| serializeTCPDFtagParameters ($pararray) | |
| setTextRenderingMode ($stroke=0, $fill=true, $clip=false) | |
| getHyphenPatternsFromTEX ($file) | |
| 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) | |
Protected Member Functions | |
| setPageFormat ($format, $orientation='P') | |
| swapPageBoxCoordinates ($page) | |
| 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') | |
| getCellBorder ($x, $y, $w, $h, $brd) | |
| getBorderMode ($brd, $position='start') | |
| getRemainingWidth () | |
| fitBlock ($w, $h, $x, $y, $fitonpage=false) | |
| _toJPEG ($image) | |
| _toPNG ($image) | |
| _setGDImageTransparency ($new_image, $image) | |
| _parsejpeg ($file) | |
| _parsepng ($file) | |
| rfread ($handle, $length) | |
| ImagePngAlpha ($file, $x, $y, $wpx, $hpx, $w, $h, $type, $link, $align, $resize, $dpi, $palign, $filehash='') | |
| getGDgamma ($v) | |
| sendOutputData ($data, $length) | |
| _dochecks () | |
| _getfontpath () | |
| getInternalPageNumberAliases ($a= '') | |
| getAllInternalPageNumberAliases () | |
| replacePageNumAliases ($page, $replace, $diff=0) | |
| replaceRightShiftPageNumAliases ($page, $aliases, $diff) | |
| _putpages () | |
| _putannotsrefs ($n) | |
| _getannotsrefs ($n) | |
| _putannotsobjs () | |
| _putAPXObject ($w=0, $h=0, $stream='') | |
| _getULONG ($str, $offset) | |
| _getUSHORT ($str, $offset) | |
| _getSHORT ($str, $offset) | |
| _getFWORD ($str, $offset) | |
| _getUFWORD ($str, $offset) | |
| _getFIXED ($str, $offset) | |
| _getBYTE ($str, $offset) | |
| updateCIDtoGIDmap ($map, $cid, $gid) | |
| _getTrueTypeFontSubset ($font, $subsetchars) | |
| _getTTFtableChecksum ($table, $length) | |
| _putfontwidths ($font, $cidoffset=0) | |
| _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) | |
| _freadint ($f) | |
| _escape ($s) | |
| _datastring ($s, $n=0) | |
| _datestring ($n=0) | |
| _textstring ($s, $n=0) | |
| _escapetext ($s) | |
| _escapeXML ($str) | |
| _getrawstream ($s, $n=0) | |
| _getstream ($s, $n=0) | |
| _putstream ($s, $n=0) | |
| _out ($s) | |
| UTF8StringToArray ($str) | |
| UTF8ToUTF16BE ($str, $setbom=false) | |
| UTF8ToLatin1 ($str) | |
| UTF8ArrToLatin1 ($unicode) | |
| arrUTF8ToUTF16BE ($unicode, $setbom=false) | |
| getRandomSeed ($seed='') | |
| _objectkey ($n) | |
| _encrypt_data ($n, $s) | |
| _putencryption () | |
| _RC4 ($key, $text) | |
| _AES ($key, $text) | |
| _md5_16 ($str) | |
| _Uvalue () | |
| _UEvalue () | |
| _Ovalue () | |
| _OEvalue () | |
| _fixAES256Password ($password) | |
| _generateencryptionkey () | |
| getUserPermissionCode ($permissions, $mode=0) | |
| convertHexStringToString ($bs) | |
| convertStringToHexString ($s) | |
| getEncPermissionsString ($protection) | |
| 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) | |
| utf8StrRev ($str, $setbom=false, $forcertl=false) | |
| utf8StrArrRev ($arr, $str='', $setbom=false, $forcertl=false) | |
| utf8Bidi ($ta, $str='', $forcertl=false) | |
| encodeNameObject ($name) | |
| _putdests () | |
| sortBookmarks () | |
| _putbookmarks () | |
| _putjavascript () | |
| _JScolor ($color) | |
| _addfield ($type, $name, $x, $y, $w, $h, $prop) | |
| getAnnotOptFromJSProp ($prop) | |
| _putsignature () | |
| getSignatureAppearanceArray ($x=0, $y=0, $w=0, $h=0, $page=-1) | |
| formatPageNumber ($num) | |
| formatTOCPageNumber ($num) | |
| _putocg () | |
| addExtGState ($parms) | |
| setExtGState ($gs) | |
| _putextgstates () | |
| Clip ($x, $y, $w, $h) | |
| _putshaders () | |
| extractCSSproperties ($cssdata) | |
| isValidCSSSelectorForTag ($dom, $key, $selector) | |
| getCSSdataArray ($dom, $key, $css) | |
| getTagStyleFromCSSarray ($css) | |
| 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) | |
| getObjFilename ($name) | |
| 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) | |
| getPathPaintOperator ($style, $default='S') | |
| checkPageRegions ($h, $x, $y) | |
| getSVGTransformMatrix ($attribute) | |
| getTransformationMatrixProduct ($ta, $tb) | |
| convertSVGtMatrix ($tm) | |
| SVGTransform ($tm) | |
| setSVGStyles ($svgstyle, $prevsvgstyle, $x=0, $y=0, $w=1, $h=1, $clip_function='', $clip_params=array()) | |
| SVGPath ($d, $style='') | |
| getVectorsAngle ($x1, $y1, $x2, $y2) | |
| startSVGElementHandler ($parser, $name, $attribs, $ctm=array()) | |
| endSVGElementHandler ($parser, $name) | |
| segSVGContentHandler ($parser, $data) | |
Protected Attributes | |
| $page | |
| $n | |
| $offsets | |
| $buffer | |
| $pages = array() | |
| $state | |
| $compress | |
| $CurOrientation | |
| $pagedim = array() | |
| $k | |
| $fwPt | |
| $fhPt | |
| $wPt | |
| $hPt | |
| $w | |
| $h | |
| $lMargin | |
| $tMargin | |
| $rMargin | |
| $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() | |
| $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 | |
| $alias_tot_pages = '{:ptp:}' | |
| $alias_num_page = '{:pnp:}' | |
| $alias_group_tot_pages = '{:ptg:}' | |
| $alias_group_num_page = '{:png:}' | |
| $alias_right_shift = '{rsc:' | |
| $img_rb_x | |
| $img_rb_y | |
| $imgscale = 1 | |
| $isunicode = false | |
| $unicode | |
| $encmaps | |
| $PDFVersion = '1.7' | |
| $header_xobjid = -1 | |
| $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 = '' | |
| $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 | |
| $enc_padding = "\x28\xBF\x4E\x5E\x4E\x75\x8A\x41\x64\x00\x4E\x56\xFF\xFA\x01\x08\x2E\x2E\x00\xB6\xD0\x68\x3E\x80\x2F\x0C\xA9\xFE\x64\x53\x69\x7A" | |
| $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() | |
| $cache_UTF8StringToArray = array() | |
| $cache_maxsize_UTF8StringToArray = 8 | |
| $cache_size_UTF8StringToArray = 0 | |
| $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 | |
| $byterange_string = '/ByteRange[0 ********** ********** **********]' | |
| $sig_annot_ref = '***SIGANNREF*** 0 R' | |
| $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() | |
| $webcolor = array() | |
| $spotcolor = array() | |
| $pdflayers = array() | |
| $dests = array() | |
| $n_dests | |
| $svgdir = '' | |
| $svgunit = 'px' | |
| $svggradients = array() | |
| $svggradientid = 0 | |
| $svgdefsmode = false | |
| $svgdefs = array() | |
| $svgclipmode = false | |
| $svgclippaths = array() | |
| $svgcliptm = array() | |
| $svgclipid = 0 | |
| $svgtext = '' | |
| $svgtextmode = array() | |
| $svginheritprop = array('clip-rule', 'color', 'color-interpolation', 'color-interpolation-filters', 'color-profile', 'color-rendering', 'cursor', 'direction', 'fill', 'fill-opacity', 'fill-rule', 'font', 'font-family', 'font-size', 'font-size-adjust', 'font-stretch', 'font-style', 'font-variant', 'font-weight', 'glyph-orientation-horizontal', 'glyph-orientation-vertical', 'image-rendering', 'kerning', 'letter-spacing', 'marker', 'marker-end', 'marker-mid', 'marker-start', 'pointer-events', 'shape-rendering', 'stroke', 'stroke-dasharray', 'stroke-dashoffset', 'stroke-linecap', 'stroke-linejoin', 'stroke-miterlimit', 'stroke-opacity', 'stroke-width', 'text-anchor', 'text-rendering', 'visibility', 'word-spacing', 'writing-mode') | |
| $svgstyles | |
| $force_srgb = false | |
| $pdfa_mode = false | |
| $doc_date | |
| $custom_xmp = '' | |
PHP class for generating PDF documents without requiring external extensions. TCPDF project (http://www.tcpdf.org) has been originally derived in 2002 from the Public Domain FPDF class by Olivier Plathey (http://www.fpdf.org), but now is almost entirely rewritten.
| __construct | ( | $ | orientation = 'P', |
| $ | unit = 'mm', |
||
| $ | format = 'A4', |
||
| $ | unicode = true, |
||
| $ | encoding = 'UTF-8', |
||
| $ | diskcache = false, |
||
| $ | pdfa = false |
||
| ) |
This is the class constructor. It allows to set up the page format, the orientation and the measure unit used in all the methods (except for the font sizes).
| $orientation | (string) page orientation. Possible values are (case insensitive):
|
| $unit | (string) User measure unit. Possible values are:
A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit. |
| $format | (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat(). |
| $unicode | (boolean) TRUE means that the input text is unicode (default = true) |
| $encoding | (string) Charset encoding; default is UTF-8. |
| $diskcache | (boolean) If TRUE reduce the RAM memory usage by caching temporary data on filesystem (slower). |
| $pdfa | (boolean) If TRUE set the document to PDF/A mode. |
Definition at line 1849 of file tcpdf.php.
| __destruct | ( | ) |
| _addfield | ( | $ | type, |
| $ | name, | ||
| $ | x, | ||
| $ | y, | ||
| $ | w, | ||
| $ | h, | ||
| $ | prop | ||
| ) | [protected] |
Adds a javascript form field.
| $type | (string) field type |
| $name | (string) field name |
| $x | (int) horizontal position |
| $y | (int) vertical position |
| $w | (int) width |
| $h | (int) height |
| $prop | (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
Definition at line 16441 of file tcpdf.php.
| _AES | ( | $ | key, |
| $ | text | ||
| ) | [protected] |
Returns the input text exrypted using AES algorithm and the specified key. This method requires mcrypt.
| $key | (string) encryption key |
| $text | (String) input text to be encrypted |
Definition at line 13823 of file tcpdf.php.
| _beginpage | ( | $ | orientation = '', |
| $ | format = '' |
||
| ) | [protected] |
Initialize a new page.
| $orientation | (string) page orientation. Possible values are (case insensitive):
|
| $format | (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat(). |
Definition at line 12712 of file tcpdf.php.
| _datastring | ( | $ | s, |
| $ | n = 0 |
||
| ) | [protected] |
| _datestring | ( | $ | n = 0 | ) | [protected] |
| _destroy | ( | $ | destroyall = false, |
| $ | preserve_objcopy = false |
||
| ) |
Unset all class variables except the following critical variables: internal_encoding, state, bufferlen, buffer and diskcache.
| $destroyall | (boolean) if true destroys all class variables, otherwise preserves critical variables. |
| $preserve_objcopy | (boolean) if true preserves the objcopy variable |
Definition at line 8664 of file tcpdf.php.
| _dochecks | ( | ) | [protected] |
| _dolinethrough | ( | $ | x, |
| $ | y, | ||
| $ | txt | ||
| ) | [protected] |
| _dolinethroughw | ( | $ | x, |
| $ | y, | ||
| $ | w | ||
| ) | [protected] |
| _dooverline | ( | $ | x, |
| $ | y, | ||
| $ | txt | ||
| ) | [protected] |
| _dooverlinew | ( | $ | x, |
| $ | y, | ||
| $ | w | ||
| ) | [protected] |
| _dounderline | ( | $ | x, |
| $ | y, | ||
| $ | txt | ||
| ) | [protected] |
| _dounderlinew | ( | $ | x, |
| $ | y, | ||
| $ | w | ||
| ) | [protected] |
| _encrypt_data | ( | $ | n, |
| $ | s | ||
| ) | [protected] |
| _enddoc | ( | ) | [protected] |
| _endpage | ( | ) | [protected] |
| _escape | ( | $ | s | ) | [protected] |
| _escapetext | ( | $ | s | ) | [protected] |
| _escapeXML | ( | $ | str | ) | [protected] |
| _fixAES256Password | ( | $ | password | ) | [protected] |
| _freadint | ( | $ | f | ) | [protected] |
| _generateencryptionkey | ( | ) | [protected] |
| _getannotsrefs | ( | $ | n | ) | [protected] |
| _getBYTE | ( | $ | str, |
| $ | offset | ||
| ) | [protected] |
| _getFIXED | ( | $ | str, |
| $ | offset | ||
| ) | [protected] |
Get FIXED from string (32-bit signed fixed-point number (16.16).
| $str | (string) string from where to extract value |
| $offset | (int) point from where to read the data |
Definition at line 9770 of file tcpdf.php.
| _getfontpath | ( | ) | [protected] |
Return fonts path
Reimplemented in pdf, and testable_pdf.
Definition at line 8708 of file tcpdf.php.
| _getFWORD | ( | $ | str, |
| $ | offset | ||
| ) | [protected] |
Get FWORD from string (Big Endian 16-bit signed integer).
| $str | (string) string from where to extract value |
| $offset | (int) point from where to read the data |
Definition at line 9739 of file tcpdf.php.
| _getobj | ( | $ | objid = '' | ) | [protected] |
| _getrawstream | ( | $ | s, |
| $ | n = 0 |
||
| ) | [protected] |
| _getSHORT | ( | $ | str, |
| $ | offset | ||
| ) | [protected] |
Get SHORT from string (Big Endian 16-bit signed integer).
| $str | (string) string from where to extract value |
| $offset | (int) point from where to read the data |
Definition at line 9725 of file tcpdf.php.
| _getstream | ( | $ | s, |
| $ | n = 0 |
||
| ) | [protected] |
| _getTrueTypeFontSubset | ( | $ | font, |
| $ | subsetchars | ||
| ) | [protected] |
Returns a subset of the TrueType font data without the unused glyphs.
| $font | (string) TrueType font data. |
| $subsetchars | (array) Array of used characters (the glyphs to keep). |
Definition at line 10653 of file tcpdf.php.
| _getTTFtableChecksum | ( | $ | table, |
| $ | length | ||
| ) | [protected] |
| _getUFWORD | ( | $ | str, |
| $ | offset | ||
| ) | [protected] |
Get UFWORD from string (Big Endian 16-bit unsigned integer).
| $str | (string) string from where to extract value |
| $offset | (int) point from where to read the data |
Definition at line 9756 of file tcpdf.php.
| _getULONG | ( | $ | str, |
| $ | offset | ||
| ) | [protected] |
Get ULONG from string (Big Endian 32-bit unsigned integer).
| $str | (string) string from where to extract value |
| $offset | (int) point from where to read the data |
Definition at line 9697 of file tcpdf.php.
| _getUSHORT | ( | $ | str, |
| $ | offset | ||
| ) | [protected] |
Get USHORT from string (Big Endian 16-bit unsigned integer).
| $str | (string) string from where to extract value |
| $offset | (int) point from where to read the data |
Definition at line 9711 of file tcpdf.php.
| _getxobjectdict | ( | ) | [protected] |
| _JScolor | ( | $ | color | ) | [protected] |
| _md5_16 | ( | $ | str | ) | [protected] |
| _newobj | ( | ) | [protected] |
| _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.
| $n | (int) object number |
Definition at line 13606 of file tcpdf.php.
| _OEvalue | ( | ) | [protected] |
| _out | ( | $ | s | ) | [protected] |
| _outCurve | ( | $ | x1, |
| $ | y1, | ||
| $ | x2, | ||
| $ | y2, | ||
| $ | x3, | ||
| $ | y3 | ||
| ) | [protected] |
Append a cubic Bézier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using (x1, y1) and (x2, y2) as the Bézier control points. The new current point shall be (x3, y3).
| $x1 | (float) Abscissa of control point 1. |
| $y1 | (float) Ordinate of control point 1. |
| $x2 | (float) Abscissa of control point 2. |
| $y2 | (float) Ordinate of control point 2. |
| $x3 | (float) Abscissa of end point. |
| $y3 | (float) Ordinate of end point. |
Definition at line 14755 of file tcpdf.php.
| _outCurveV | ( | $ | x2, |
| $ | y2, | ||
| $ | x3, | ||
| $ | y3 | ||
| ) | [protected] |
Append a cubic Bézier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using the current point and (x2, y2) as the Bézier control points. The new current point shall be (x3, y3).
| $x2 | (float) Abscissa of control point 2. |
| $y2 | (float) Ordinate of control point 2. |
| $x3 | (float) Abscissa of end point. |
| $y3 | (float) Ordinate of end point. |
Definition at line 14769 of file tcpdf.php.
| _outCurveY | ( | $ | x1, |
| $ | y1, | ||
| $ | x3, | ||
| $ | y3 | ||
| ) | [protected] |
Append a cubic Bézier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using (x1, y1) and (x3, y3) as the Bézier control points. The new current point shall be (x3, y3).
| $x1 | (float) Abscissa of control point 1. |
| $y1 | (float) Ordinate of control point 1. |
| $x3 | (float) Abscissa of end point. |
| $y3 | (float) Ordinate of end point. |
Definition at line 14783 of file tcpdf.php.
| _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.
| $xc | (float) Abscissa of center point. |
| $yc | (float) Ordinate of center point. |
| $rx | (float) Horizontal radius. |
| $ry | (float) Vertical radius (if ry = 0 then is a circle, see Circle()). Default value: 0. |
| $xang,: | (float) Angle between the X-axis and the major axis of the ellipse. Default value: 0. |
| $angs,: | (float) Angle start of draw line. Default value: 0. |
| $angf,: | (float) Angle finish of draw line. Default value: 360. |
| $pie | (boolean) if true do not mark the border point (used to draw pie sectors). |
| $nc | (integer) Number of curves used to draw a 90 degrees portion of ellipse. |
| $startpoint | (boolean) if true output a starting point. |
| $ccw | (boolean) if true draws in counter-clockwise. |
| $svg | (boolean) if true the angles are in svg mode (already calculated). |
Definition at line 14983 of file tcpdf.php.
| _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).
| $x | (float) Abscissa of end point. |
| $y | (float) Ordinate of end point. |
Definition at line 14725 of file tcpdf.php.
| _outPoint | ( | $ | x, |
| $ | y | ||
| ) | [protected] |
Begin a new subpath by moving the current point to coordinates (x, y), omitting any connecting line segment.
| $x | (float) Abscissa of point. |
| $y | (float) Ordinate of point. |
Definition at line 14713 of file tcpdf.php.
| _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.
| $x | (float) Abscissa of upper-left corner. |
| $y | (float) Ordinate of upper-left corner. |
| $w | (float) Width. |
| $h | (float) Height. |
| $op | (string) options |
Definition at line 14739 of file tcpdf.php.
| _Ovalue | ( | ) | [protected] |
| _parsejpeg | ( | $ | file | ) | [protected] |
| _parsepng | ( | $ | file | ) | [protected] |
| _putannotsobjs | ( | ) | [protected] |
| _putannotsrefs | ( | $ | n | ) | [protected] |
| _putAPXObject | ( | $ | w = 0, |
| $ | h = 0, |
||
| $ | stream = '' |
||
| ) | [protected] |
Put appearance streams XObject used to define annotation's appearance states.
| $w | (int) annotation width |
| $h | (int) annotation height |
| $stream | (string) appearance stream |
Definition at line 9663 of file tcpdf.php.
| _putbookmarks | ( | ) | [protected] |
| _putcatalog | ( | ) | [protected] |
| _putcidfont0 | ( | $ | font | ) | [protected] |
| _putdests | ( | ) | [protected] |
| _putEmbeddedFiles | ( | ) | [protected] |
Embedd the attached files.
Definition at line 5462 of file tcpdf.php.
| _putencryption | ( | ) | [protected] |
| _putextgstates | ( | ) | [protected] |
| _putfonts | ( | ) | [protected] |
| _putfontwidths | ( | $ | font, |
| $ | cidoffset = 0 |
||
| ) | [protected] |
| _putheader | ( | ) | [protected] |
| _putimages | ( | ) | [protected] |
| _putinfo | ( | ) | [protected] |
Adds some Metadata information (Document Information Dictionary) (see Chapter 14.3.3 Document Information Dictionary of PDF32000_2008.pdf Reference)
Definition at line 12171 of file tcpdf.php.
| _putjavascript | ( | ) | [protected] |
| _putocg | ( | ) | [protected] |
| _putpages | ( | ) | [protected] |
| _putresourcedict | ( | ) | [protected] |
| _putresources | ( | ) | [protected] |
| _putshaders | ( | ) | [protected] |
| _putsignature | ( | ) | [protected] |
| _putspotcolors | ( | ) | [protected] |
| _putstream | ( | $ | s, |
| $ | n = 0 |
||
| ) | [protected] |
| _puttruetypeunicode | ( | $ | font | ) | [protected] |
| _putviewerpreferences | ( | ) | [protected] |
| _putXMP | ( | ) | [protected] |
| _putxobjects | ( | ) | [protected] |
Output Form XObjects Templates.
Definition at line 11949 of file tcpdf.php.
| _RC4 | ( | $ | key, |
| $ | text | ||
| ) | [protected] |
Returns the input text encrypted using RC4 algorithm and the specified key. RC4 is the standard encryption algorithm used in PDF format
| $key | (string) encryption key |
| $text | (String) input text to be encrypted |
Definition at line 13777 of file tcpdf.php.
| _setGDImageTransparency | ( | $ | new_image, |
| $ | image | ||
| ) | [protected] |
| _textstring | ( | $ | s, |
| $ | n = 0 |
||
| ) | [protected] |
| _toJPEG | ( | $ | image | ) | [protected] |
Convert the loaded image to a JPEG and then return a structure for the PDF creator. This function requires GD library and write access to the directory defined on K_PATH_CACHE constant.
| $image | (image) Image object. return image JPEG image object. |
Definition at line 7915 of file tcpdf.php.
| _toPNG | ( | $ | image | ) | [protected] |
Convert the loaded image to a PNG and then return a structure for the PDF creator. This function requires GD library and write access to the directory defined on K_PATH_CACHE constant.
| $image | (image) Image object. return image PNG image object. |
Definition at line 7933 of file tcpdf.php.
| _UEvalue | ( | ) | [protected] |
| _Uvalue | ( | ) | [protected] |
| AcceptPageBreak | ( | ) |
Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value. The default implementation returns a value according to the mode selected by SetAutoPageBreak().
This method is called automatically and should not be called directly by the application.
Definition at line 5527 of file tcpdf.php.
| addEmptySignatureAppearance | ( | $ | x = 0, |
| $ | y = 0, |
||
| $ | w = 0, |
||
| $ | h = 0, |
||
| $ | page = -1 |
||
| ) |
Add an empty digital signature appearance (a cliccable rectangle area to get signature properties)
| $x | (float) Abscissa of the upper-left corner. |
| $y | (float) Ordinate of the upper-left corner. |
| $w | (float) Width of the signature area. |
| $h | (float) Height of the signature area. |
| $page | (int) option page number (if < 0 the current page is used). |
Definition at line 17639 of file tcpdf.php.
| addExtGState | ( | $ | parms | ) | [protected] |
Imports a TrueType, Type1, core, or CID0 font and makes it available. It is necessary to generate a font definition file first (read /fonts/utils/README.TXT). The definition file (and the font file itself when embedding) must be present either in the current directory or in the one indicated by K_PATH_FONTS if the constant is defined. If it could not be found, the error "Could not include font definition file" is generated.
| $family | (string) Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font. |
| $style | (string) Font style. Possible values are (case insensitive):
|
| $fontfile | (string) The font definition file. By default, the name is built from the family and style, in lower case with no spaces. |
| $subset | (mixed) if true embedd only a subset of the font (stores only the information related to the used characters); if false embedd full font; if 'default' uses the default value set using setFontSubsetting(). This option is valid only for TrueTypeUnicode fonts. If you want to enable users to change the document, set this parameter to false. If you subset the font, the person who receives your PDF would need to have your same font in order to make changes to your PDF. The file size of the PDF would also be smaller because you are embedding only part of a font. |
Definition at line 4933 of file tcpdf.php.
| addHtmlLink | ( | $ | url, |
| $ | name, | ||
| $ | fill = false, |
||
| $ | firstline = false, |
||
| $ | color = '', |
||
| $ | style = -1, |
||
| $ | firstblock = false |
||
| ) |
Output anchor link.
| $url | (string) link URL or internal link (i.e.: <a href="#23,4.5">link to page 23 at 4.5 Y position</a>) |
| $name | (string) link name |
| $fill | (boolean) Indicates if the cell background must be painted (true) or transparent (false). |
| $firstline | (boolean) if true prints only the first line and return the remaining string. |
| $color | (array) array of RGB text color |
| $style | (string) font style (U, D, B, I) |
| $firstblock | (boolean) if true the string is the starting of a line. |
Definition at line 13383 of file tcpdf.php.
| addHTMLTOC | ( | $ | page = '', |
| $ | toc_name = 'TOC', |
||
| $ | templates = array(), |
||
| $ | correct_align = true, |
||
| $ | style = '', |
||
| $ | color = array(0,0,0) |
||
| ) |
Output a Table Of Content Index (TOC) using HTML templates. This method must be called after all Bookmarks were set. Before calling this method you have to open the page using the addTOCPage() method. After calling this method you have to call endTOCPage() to close the TOC page.
| $page | (int) page number where this TOC should be inserted (leave empty for current page). |
| $toc_name | (string) name to use for TOC bookmark. |
| $templates | (array) array of html templates. Use: "#TOC_DESCRIPTION#" for bookmark title, "#TOC_PAGE_NUMBER#" for page number. |
| $correct_align | (boolean) if true correct the number alignment (numbers must be in monospaced font like courier and right aligned on LTR, or left aligned on RTL) |
| $style | (string) Font style for title: B = Bold, I = Italic, BI = Bold + Italic. |
| $color | (array) RGB color array for title (values from 0 to 255). |
Definition at line 25822 of file tcpdf.php.
| addHTMLVertSpace | ( | $ | hbz = 0, |
| $ | hb = 0, |
||
| $ | cell = false, |
||
| $ | firsttag = false, |
||
| $ | lasttag = false |
||
| ) | [protected] |
Add vertical spaces if needed.
| $hbz | (string) Distance between current y and line bottom. |
| $hb | (string) The height of the break. |
| $cell | (boolean) if true add the default left (or right if RTL) padding to each new line (default false). |
| $firsttag | (boolean) set to true when the tag is the first. |
| $lasttag | (boolean) set to true when the tag is the last. |
Definition at line 24128 of file tcpdf.php.
| addJavascriptObject | ( | $ | script, |
| $ | onload = false |
||
| ) |
| AddLink | ( | ) |
Creates a new internal link and returns its identifier. An internal link is a clickable area which directs to another place within the document.
The identifier can then be passed to Cell(), Write(), Image() or Link(). The destination is defined with SetLink().
Definition at line 5316 of file tcpdf.php.
| AddPage | ( | $ | orientation = '', |
| $ | format = '', |
||
| $ | keepmargins = false, |
||
| $ | tocpage = false |
||
| ) |
Adds a new page to the document. If a page is already present, the Footer() method is called first to output the footer (if enabled). Then the page is added, the current position set to the top-left corner according to the left and top margins (or top-right if in RTL mode), and Header() is called to display the header (if enabled). The origin of the coordinate system is at the top-left corner (or top-right for RTL) and increasing ordinates go downwards.
| $orientation | (string) page orientation. Possible values are (case insensitive):
|
| $format | (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat(). |
| $keepmargins | (boolean) if true overwrites the default page margins with the current margins |
| $tocpage | (boolean) if true set the tocpage state to true (the added page will be used to display Table Of Content). |
Definition at line 3885 of file tcpdf.php.
| addPageRegion | ( | $ | region | ) |
Add a single no-write region on selected page. A no-write region is a portion of the page with a rectangular or trapezium shape that will not be covered when writing text or html code. A region is always aligned on the left or right side of the page ad is defined using a vertical segment. You can set multiple regions for the same page.
| $region | (array) array of a single no-write region array: ('page' => page number or empy for current page, 'xt' => X top, 'yt' => Y top, 'xb' => X bottom, 'yb' => Y bottom, 'side' => page side 'L' = left or 'R' = right). |
Definition at line 26944 of file 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.
| $name | (string) Full name of the spot color. |
| $c | (float) Cyan color for CMYK. Value between 0 and 100. |
| $m | (float) Magenta color for CMYK. Value between 0 and 100. |
| $y | (float) Yellow color for CMYK. Value between 0 and 100. |
| $k | (float) Key (Black) color for CMYK. Value between 0 and 100. |
Definition at line 4460 of file tcpdf.php.
| addTOC | ( | $ | page = '', |
| $ | numbersfont = '', |
||
| $ | filler = '.', |
||
| $ | toc_name = 'TOC', |
||
| $ | style = '', |
||
| $ | color = array(0,0,0) |
||
| ) |
Output a Table of Content Index (TOC). This method must be called after all Bookmarks were set. Before calling this method you have to open the page using the addTOCPage() method. After calling this method you have to call endTOCPage() to close the TOC page. You can override this method to achieve different styles.
| $page | (int) page number where this TOC should be inserted (leave empty for current page). |
| $numbersfont | (string) set the font for page numbers (please use monospaced font for better alignment). |
| $filler | (string) string used to fill the space between text and page number. |
| $toc_name | (string) name to use for TOC bookmark. |
| $style | (string) Font style for title: B = Bold, I = Italic, BI = Bold + Italic. |
| $color | (array) RGB color array for bookmark title (values from 0 to 255). |
Definition at line 25641 of file tcpdf.php.
| addTOCPage | ( | $ | orientation = '', |
| $ | format = '', |
||
| $ | keepmargins = false |
||
| ) |
Adds a new TOC (Table Of Content) page to the document.
| $orientation | (string) page orientation. |
| $format | (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat(). |
| $keepmargins | (boolean) if true overwrites the default page margins with the current margins |
Definition at line 3860 of file tcpdf.php.
| addTTFfont | ( | $ | fontfile, |
| $ | fonttype = '', |
||
| $ | enc = '', |
||
| $ | flags = 32, |
||
| $ | outpath = '' |
||
| ) |
Convert and add the selected TrueType or Type1 font to the fonts folder (that must be writeable).
| $fontfile | (string) TrueType or Type1 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. |
Definition at line 9825 of file tcpdf.php.
| adjustCellPadding | ( | $ | brd = 0 | ) | [protected] |
Adjust the internal Cell padding array to take account of the line width.
| $brd | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
Definition at line 3443 of file tcpdf.php.
| AliasNbPages | ( | $ | s = '' | ) |
This method is DEPRECATED and doesn't have any effect. Please remove any reference to this method.
| $s | (string) Empty parameter. |
| AliasNumPage | ( | $ | s = '' | ) |
This method is DEPRECATED and doesn't have any effect. Please remove any reference to this method.
| $s | (string) Empty parameter. |
| Annotation | ( | $ | x, |
| $ | y, | ||
| $ | w, | ||
| $ | h, | ||
| $ | text, | ||
| $ | opt = array('Subtype'=>'Text'), |
||
| $ | spaces = 0 |
||
| ) |
Puts a markup annotation on a rectangular area of the page. !!!!THE ANNOTATION SUPPORT IS NOT YET FULLY IMPLEMENTED !!!!
| $x | (float) Abscissa of the upper-left corner of the rectangle |
| $y | (float) Ordinate of the upper-left corner of the rectangle |
| $w | (float) Width of the rectangle |
| $h | (float) Height of the rectangle |
| $text | (string) annotation text or alternate content |
| $opt | (array) array of options (see section 8.4 of PDF reference 1.7). |
| $spaces | (int) number of spaces on the text to link |
Definition at line 5372 of file tcpdf.php.
| Arrow | ( | $ | x0, |
| $ | y0, | ||
| $ | x1, | ||
| $ | y1, | ||
| $ | head_style = 0, |
||
| $ | arm_size = 5, |
||
| $ | arm_angle = 15 |
||
| ) |
Draws a grahic arrow.
| $x0 | (float) Abscissa of first point. |
| $y0 | (float) Ordinate of first point. |
| $x1 | (float) Abscissa of second point. |
| $y1 | (float) Ordinate of second point. |
| $head_style | (int) (0 = draw only arrowhead arms, 1 = draw closed arrowhead, but no fill, 2 = closed and filled arrowhead, 3 = filled arrowhead) |
| $arm_size | (float) length of arrowhead arms |
| $arm_angle | (int) angle between an arm and the shaft |
Definition at line 15422 of file tcpdf.php.
| arrUTF8ToUTF16BE | ( | $ | unicode, |
| $ | setbom = false |
||
| ) | [protected] |
Converts array of UTF-8 characters to UTF16-BE string.
Based on: http://www.faqs.org/rfcs/rfc2781.html
Encoding UTF-16:
Encoding of a single character from an ISO 10646 character value to
UTF-16 proceeds as follows. Let U be the character number, no greater
than 0x10FFFF. 1) If U < 0x10000, encode U as a 16-bit unsigned integer and
terminate. 2) Let U' = U - 0x10000. Because U is less than or equal to 0x10FFFF,
U' must be less than or equal to 0xFFFFF. That is, U' can be
represented in 20 bits. 3) Initialize two 16-bit unsigned integers, W1 and W2, to 0xD800 and
0xDC00, respectively. These integers each have 10 bits free to
encode the character value, for a total of 20 bits. 4) Assign the 10 high-order bits of the 20-bit U' to the 10 low-order
bits of W1 and the 10 low-order bits of U' to the 10 low-order
bits of W2. Terminate. Graphically, steps 2 through 4 look like:
U' = yyyyyyyyyyxxxxxxxxxx
W1 = 110110yyyyyyyyyy
W2 = 110111xxxxxxxxxx
| $unicode | (array) array containing UTF-8 unicode values |
| $setbom | (boolean) if true set the Byte Order Mark (BOM = 0xFEFF) |
Definition at line 13278 of file tcpdf.php.
Adds a bookmark.
| $txt | (string) Bookmark description. |
| $level | (int) Bookmark level (minimum value is 0). |
| $y | (float) Y position in user units of the bookmark on the selected page (default = -1 = current position; 0 = page start;). |
| $page | (int) Target page number (leave empty for current page). |
| $style | (string) Font style: B = Bold, I = Italic, BI = Bold + Italic. |
| $color | (array) RGB color array (values from 0 to 255). |
Definition at line 16187 of file tcpdf.php.
| Button | ( | $ | name, |
| $ | w, | ||
| $ | h, | ||
| $ | caption, | ||
| $ | action, | ||
| $ | prop = array(), |
||
| $ | opt = array(), |
||
| $ | x = '', |
||
| $ | y = '', |
||
| $ | js = false |
||
| ) |
Creates a button field
| $name | (string) field name |
| $w | (int) width |
| $h | (int) height |
| $caption | (string) caption. |
| $action | (mixed) action triggered by pressing the button. Use a string to specify a javascript action. Use an array to specify a form action options as on section 12.7.5 of PDF32000_2008. |
| $prop | (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
| $opt | (array) annotation parameters. Possible values are described on official PDF32000_2008 reference. |
| $x | (float) Abscissa of the upper-left corner of the rectangle |
| $y | (float) Ordinate of the upper-left corner of the rectangle |
| $js | (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered). |
Definition at line 17299 of file tcpdf.php.
| Cell | ( | $ | w, |
| $ | h = 0, |
||
| $ | txt = '', |
||
| $ | border = 0, |
||
| $ | ln = 0, |
||
| $ | align = '', |
||
| $ | fill = false, |
||
| $ | link = '', |
||
| $ | stretch = 0, |
||
| $ | ignore_min_height = false, |
||
| $ | calign = 'T', |
||
| $ | valign = 'M' |
||
| ) |
Prints a cell (rectangular area) with optional borders, background color and character string. The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text.
If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
| $w | (float) Cell width. If 0, the cell extends up to the right margin. |
| $h | (float) Cell height. Default value: 0. |
| $txt | (string) String to print. Default value: empty string. |
| $border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
| $ln | (int) Indicates where the current position should go after the call. Possible values are:
|
| $align | (string) Allows to center or align the text. Possible values are:
|
| $fill | (boolean) Indicates if the cell background must be painted (true) or transparent (false). |
| $link | (mixed) URL or identifier returned by AddLink(). |
| $stretch | (int) font stretch mode:
|
| $ignore_min_height | (boolean) if true ignore automatic minimum height value. |
| $calign | (string) cell vertical alignment relative to the specified Y value. Possible values are:
|
| $valign | (string) text vertical alignment inside the cell. Possible values are:
|
Definition at line 5632 of file tcpdf.php.
| CheckBox | ( | $ | name, |
| $ | w, | ||
| $ | checked = false, |
||
| $ | prop = array(), |
||
| $ | opt = array(), |
||
| $ | onvalue = 'Yes', |
||
| $ | x = '', |
||
| $ | y = '', |
||
| $ | js = false |
||
| ) |
Creates a CheckBox field
| $name | (string) field name |
| $w | (int) width |
| $checked | (boolean) define the initial state. |
| $prop | (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
| $opt | (array) annotation parameters. Possible values are described on official PDF32000_2008 reference. |
| $onvalue | (string) value to be returned if selected. |
| $x | (float) Abscissa of the upper-left corner of the rectangle |
| $y | (float) Ordinate of the upper-left corner of the rectangle |
| $js | (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered). |
Definition at line 17226 of file tcpdf.php.
| checkPageBreak | ( | $ | h = 0, |
| $ | y = '', |
||
| $ | addpage = true |
||
| ) | [protected] |
Add page if needed.
| $h | (float) Cell height. Default value: 0. |
| $y | (mixed) starting y position, leave empty for current position. |
| $addpage | (boolean) if true add a page, otherwise only return the true/false state |
Definition at line 5554 of file tcpdf.php.
| 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.
| $h | (float) height of the text/image/object to print in user units |
| $x | (float) current X coordinate in user units |
| $y | (float) current Y coordinate in user units |
Definition at line 26981 of file tcpdf.php.
| Circle | ( | $ | x0, |
| $ | y0, | ||
| $ | r, | ||
| $ | angstr = 0, |
||
| $ | angend = 360, |
||
| $ | style = '', |
||
| $ | line_style = array(), |
||
| $ | fill_color = array(), |
||
| $ | nc = 2 |
||
| ) |
Draws a circle. A circle is formed from n Bezier curves.
| $x0 | (float) Abscissa of center point. |
| $y0 | (float) Ordinate of center point. |
| $r | (float) Radius. |
| $angstr,: | (float) Angle start of draw line. Default value: 0. |
| $angend,: | (float) Angle finish of draw line. Default value: 360. |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $line_style | (array) Line style of circle. Array like for SetLineStyle(). Default value: default line style (empty array). |
| $fill_color | (array) Fill color. Format: array(red, green, blue). Default value: default color (empty array). |
| $nc | (integer) Number of curves used to draw a 90 degrees portion of circle. |
Definition at line 15111 of file tcpdf.php.
| Clip | ( | $ | x, |
| $ | y, | ||
| $ | w, | ||
| $ | h | ||
| ) | [protected] |
Set a rectangular clipping area.
| $x | (float) abscissa of the top left corner of the rectangle (or top right corner for RTL mode). |
| $y | (float) ordinate of the top left corner of the rectangle. |
| $w | (float) width of the rectangle. |
| $h | (float) height of the rectangle. |
Definition at line 18434 of file tcpdf.php.
| Close | ( | ) |
Terminates the PDF document. It is not necessary to call this method explicitly because Output() does it automatically. If the document contains no page, AddPage() is called to prevent from getting an invalid document.
Definition at line 3737 of file tcpdf.php.
| closeHTMLTagHandler | ( | $ | dom, |
| $ | key, | ||
| $ | cell, | ||
| $ | maxbottomliney = 0 |
||
| ) | [protected] |
Process closing tags.
| $dom | (array) html dom array |
| $key | (int) current element id |
| $cell | (boolean) if true add the default left (or right if RTL) padding to each new line (default false). |
| $maxbottomliney | (int) maximum y value of current line |
Definition at line 23590 of file tcpdf.php.
| colorRegistrationBar | ( | $ | x, |
| $ | y, | ||
| $ | w, | ||
| $ | h, | ||
| $ | transition = true, |
||
| $ | vertical = false, |
||
| $ | colors = 'A, |
||
| R | , | ||
| G | , | ||
| B | , | ||
| C | , | ||
| M | , | ||
| Y | , | ||
| K' | |||
| ) |
Paints color transition registration bars
| $x | (float) abscissa of the top left corner of the rectangle. |
| $y | (float) ordinate of the top left corner of the rectangle. |
| $w | (float) width of the rectangle. |
| $h | (float) height of the rectangle. |
| $transition | (boolean) if true prints tcolor transitions to white. |
| $vertical | (boolean) if true prints bar vertically. |
| $colors | (string) colors to print, one letter per color separated by comma (for example 'A,W,R,G,B,C,M,Y,K'): A=black, W=white, R=red, G=green, B=blue, C=cyan, M=magenta, Y=yellow, K=black. |
Definition at line 18102 of file tcpdf.php.
| ComboBox | ( | $ | name, |
| $ | w, | ||
| $ | h, | ||
| $ | values, | ||
| $ | prop = array(), |
||
| $ | opt = array(), |
||
| $ | x = '', |
||
| $ | y = '', |
||
| $ | js = false |
||
| ) |
Creates a Combo-box field
| $name | (string) field name |
| $w | (int) width |
| $h | (int) height |
| $values | (array) array containing the list of values. |
| $prop | (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
| $opt | (array) annotation parameters. Possible values are described on official PDF32000_2008 reference. |
| $x | (float) Abscissa of the upper-left corner of the rectangle |
| $y | (float) Ordinate of the upper-left corner of the rectangle |
| $js | (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered). |
| convertHexStringToString | ( | $ | bs | ) | [protected] |
| convertHTMLColorToDec | ( | $ | hcolor = '#FFFFFF', |
| $ | defcol = array(128,128,128) |
||
| ) |
Returns an array (RGB or CMYK) from an html color name or a six-digit (i.e. #3FE5AA) or three-digit (i.e. #7FF) hexadecimal color representation.
| $hcolor | (string) HTML color. |
| $defcol | (array) Color to return in case of error. |
Definition at line 13428 of file tcpdf.php.
| convertStringToHexString | ( | $ | s | ) | [protected] |
| convertSVGtMatrix | ( | $ | tm | ) | [protected] |
| CoonsPatchMesh | ( | $ | x, |
| $ | y, | ||
| $ | w, | ||
| $ | h, | ||
| $ | col1 = array(), |
||
| $ | col2 = array(), |
||
| $ | col3 = array(), |
||
| $ | col4 = array(), |
||
| $ | coords = array(0.00,0.0,0.33,0.00,0.67,0.00,1.00,0.00,1.00,0.33,1.00,0.67,1.00,1.00,0.67,1.00,0.33,1.00,0.00,1.00,0.00,0.67,0.00,0.33), |
||
| $ | coords_min = 0, |
||
| $ | coords_max = 1, |
||
| $ | antialias = false |
||
| ) |
Paints a coons patch mesh.
| $x | (float) abscissa of the top left corner of the rectangle. |
| $y | (float) ordinate of the top left corner of the rectangle. |
| $w | (float) width of the rectangle. |
| $h | (float) height of the rectangle. |
| $col1 | (array) first color (lower left corner) (RGB components). |
| $col2 | (array) second color (lower right corner) (RGB components). |
| $col3 | (array) third color (upper right corner) (RGB components). |
| $col4 | (array) fourth color (upper left corner) (RGB components). |
| $coords | (array)
|
| $coords_min | (array) minimum value used by the coordinates. If a coordinate's value is smaller than this it will be cut to coords_min. default: 0 |
| $coords_max | (array) maximum value used by the coordinates. If a coordinate's value is greater than this it will be cut to coords_max. default: 1 |
| $antialias | (boolean) A flag indicating whether to filter the shading function to prevent aliasing artifacts. |
Definition at line 18342 of file tcpdf.php.
| copyPage | ( | $ | page = 0 | ) |
Paints crop mark
| $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 sybol per type separated by comma: A = top left, B = top right, C = bottom left, D = bottom right. |
| $color | (array) crop mark color (default black). |
Definition at line 18200 of file tcpdf.php.
| Curve | ( | $ | x0, |
| $ | y0, | ||
| $ | x1, | ||
| $ | y1, | ||
| $ | x2, | ||
| $ | y2, | ||
| $ | x3, | ||
| $ | y3, | ||
| $ | style = '', |
||
| $ | line_style = array(), |
||
| $ | fill_color = array() |
||
| ) |
Draws a Bezier curve. The Bezier curve is a tangent to the line between the control points at either end of the curve.
| $x0 | (float) Abscissa of start point. |
| $y0 | (float) Ordinate of start point. |
| $x1 | (float) Abscissa of control point 1. |
| $y1 | (float) Ordinate of control point 1. |
| $x2 | (float) Abscissa of control point 2. |
| $y2 | (float) Ordinate of control point 2. |
| $x3 | (float) Abscissa of end point. |
| $y3 | (float) Ordinate of end point. |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $line_style | (array) Line style of curve. Array like for SetLineStyle(). Default value: default line style (empty array). |
| $fill_color | (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array). |
Definition at line 14881 of file tcpdf.php.
| deletePage | ( | $ | page | ) |
| drawHTMLTagBorder | ( | $ | tag, |
| $ | xmax | ||
| ) | [protected] |
| Ellipse | ( | $ | x0, |
| $ | y0, | ||
| $ | rx, | ||
| $ | ry = '', |
||
| $ | angle = 0, |
||
| $ | astart = 0, |
||
| $ | afinish = 360, |
||
| $ | style = '', |
||
| $ | line_style = array(), |
||
| $ | fill_color = array(), |
||
| $ | nc = 2 |
||
| ) |
Draws an ellipse. An ellipse is formed from n Bezier curves.
| $x0 | (float) Abscissa of center point. |
| $y0 | (float) Ordinate of center point. |
| $rx | (float) Horizontal radius. |
| $ry | (float) Vertical radius (if ry = 0 then is a circle, see Circle()). Default value: 0. |
| $angle,: | (float) Angle oriented (anti-clockwise). Default value: 0. |
| $astart,: | (float) Angle start of draw line. Default value: 0. |
| $afinish,: | (float) Angle finish of draw line. Default value: 360. |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $line_style | (array) Line style of ellipse. Array like for SetLineStyle(). Default value: default line style (empty array). |
| $fill_color | (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array). |
| $nc | (integer) Number of curves used to draw a 90 degrees portion of ellipse. |
Definition at line 14945 of file tcpdf.php.
| empty_string | ( | $ | str | ) |
| encodeNameObject | ( | $ | name | ) | [protected] |
| endLayer | ( | ) |
| endPage | ( | $ | tocpage = false | ) |
Terminate the current page
| $tocpage | (boolean) if true set the tocpage state to false (end the page used to display Table Of Content). |
Definition at line 3909 of file tcpdf.php.
| endSVGElementHandler | ( | $ | parser, |
| $ | name | ||
| ) | [protected] |
Sets the closing SVG element handler function for the XML parser.
| $parser | (resource) The first parameter, parser, is a reference to the XML parser calling the handler. |
| $name | (string) The second parameter, name, contains the name of the element for which this handler is called. If case-folding is in effect for this parser, the element name will be in uppercase letters. |
Definition at line 28665 of file 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.
Definition at line 26711 of file tcpdf.php.
| endTOCPage | ( | ) |
Terminate the current TOC (Table Of Content) page
Definition at line 3870 of file tcpdf.php.
| Error | ( | $ | msg | ) |
This method is automatically called in case of fatal error; it simply outputs the message and halts the execution. An inherited class may override it to customize the error handling but should always halt the script, or the resulting document would probably be invalid. 2004-06-11 :: Nicola Asuni : changed bold tag with strong
| $msg | (string) The error message |
Definition at line 3710 of file tcpdf.php.
| extractCSSproperties | ( | $ | cssdata | ) | [protected] |
Extracts the CSS properties from a CSS string.
| $cssdata | (string) string containing CSS definitions. |
Definition at line 19923 of file tcpdf.php.
| fitBlock | ( | $ | w, |
| $ | h, | ||
| $ | x, | ||
| $ | y, | ||
| $ | fitonpage = false |
||
| ) | [protected] |
Set the block dimensions accounting for page breaks and page/column fitting
| $w | (float) width |
| $h | (float) height |
| $x | (float) X coordinate |
| $y | (float) Y coodiante |
| $fitonpage | (boolean) if true the block is resized to not exceed page dimensions. |
Definition at line 7372 of file tcpdf.php.
| fixHTMLCode | ( | $ | html, |
| $ | default_css = '', |
||
| $ | tagvs = '', |
||
| $ | tidy_options = '' |
||
| ) |
Cleanup HTML code (requires HTML Tidy library).
| $html | (string) htmlcode to fix |
| $default_css | (string) CSS commands to add |
| $tagvs | (array) parameters for setHtmlVSpace method |
| $tidy_options | (array) options for tidy_parse_string function |
Definition at line 19858 of file tcpdf.php.
| Footer | ( | ) |
| formatPageNumber | ( | $ | num | ) | [protected] |
| formatTOCPageNumber | ( | $ | num | ) | [protected] |
Format the page numbers on the Table Of Content. This method can be overriden for custom formats.
| $num | (int) page number |
Definition at line 17832 of file tcpdf.php.
| get_mqr | ( | ) |
Gets the current active configuration setting of magic_quotes_runtime (if the get_magic_quotes_runtime function exist)
Definition at line 7897 of file tcpdf.php.
| GetAbsX | ( | ) |
| getAliasNbPages | ( | ) |
Returns the string alias used for the total number of pages. If the current font is unicode type, the returned string is surrounded by additional curly braces. This alias will be replaced by the total number of pages in the document.
Definition at line 17741 of file tcpdf.php.
| getAliasNumPage | ( | ) |
Returns the string alias used for the page number. If the current font is unicode type, the returned string is surrounded by additional curly braces. This alias will be replaced by the page number.
Definition at line 17756 of file tcpdf.php.
Returns the string alias used right align page numbers. If the current font is unicode type, the returned string wil contain an additional open curly brace.
Definition at line 17720 of file tcpdf.php.
| getAllInternalPageNumberAliases | ( | ) | [protected] |
| getAnnotOptFromJSProp | ( | $ | prop | ) | [protected] |
Convert JavaScript form fields properties array to Annotation Properties array.
| $prop | (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
Definition at line 16476 of file tcpdf.php.
| GetArrStringWidth | ( | $ | sa, |
| $ | fontname = '', |
||
| $ | fontstyle = '', |
||
| $ | fontsize = 0, |
||
| $ | getarray = false |
||
| ) |
Returns the string length of an array of chars in user unit or an array of characters widths. A font must be selected.
| $sa | (string) The array of chars whose total length is to be computed |
| $fontname | (string) Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained. |
| $fontstyle | (string) Font style. Possible values are (case insensitive):
|
| $fontsize | (float) Font size in points. The default value is the current size. |
| $getarray | (boolean) if true returns an array of characters widths, if false returns the total length. |
Definition at line 4813 of file tcpdf.php.
| getAutoPageBreak | ( | ) |
| getBarcode | ( | ) |
| getBorderMode | ( | $ | brd, |
| $ | position = 'start' |
||
| ) | [protected] |
Get the border mode accounting for multicell position (opens bottom side of multicell crossing pages)
| $brd | (mixed) Indicates if borders must be drawn around the cell block. The value can be a number:
|
| $position | (string) multicell position: 'start', 'middle', 'end' |
Definition at line 6614 of file tcpdf.php.
| getBorderStartPosition | ( | ) | [protected] |
| getBreakMargin | ( | $ | pagenum = '' | ) |
Returns the page break margin.
| $pagenum | (int) page number (empty = current page) |
Definition at line 3261 of file tcpdf.php.
| getBuffer | ( | ) | [protected] |
| getCellBorder | ( | $ | x, |
| $ | y, | ||
| $ | w, | ||
| $ | h, | ||
| $ | brd | ||
| ) | [protected] |
Returns the code to draw the cell border
| $x | (float) X coordinate. |
| $y | (float) Y coordinate. |
| $w | (float) Cell width. |
| $h | (float) Cell height. |
| $brd | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
Definition at line 6077 of file tcpdf.php.
| 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.
| $w | (float) Cell width. If 0, the cell extends up to the right margin. |
| $h | (float) Cell height. Default value: 0. |
| $txt | (string) String to print. Default value: empty string. |
| $border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
| $ln | (int) Indicates where the current position should go after the call. Possible values are:
|
| $align | (string) Allows to center or align the text. Possible values are:
|
| $fill | (boolean) Indicates if the cell background must be painted (true) or transparent (false). |
| $link | (mixed) URL or identifier returned by AddLink(). |
| $stretch | (int) font stretch mode:
|
| $ignore_min_height | (boolean) if true ignore automatic minimum height value. |
| $calign | (string) cell vertical alignment relative to the specified Y value. Possible values are:
|
| $valign | (string) text vertical alignment inside the cell. Possible values are:
|
Definition at line 5668 of file tcpdf.php.
| getCellMargins | ( | ) |
Get the internal Cell margin array.
| getCellPaddings | ( | ) |
Get the internal Cell padding array.
| GetCharWidth | ( | $ | char, |
| $ | notlast = true |
||
| ) |
Returns the length of the char in user unit for the current font considering current stretching and spacing (tracking/kerning).
| $char | (int) The char code whose length is to be returned |
| $notlast | (boolean) set to false for the latest character on string, true otherwise (default) |
Definition at line 4850 of file tcpdf.php.
| getColumn | ( | ) |
| getCSSBorderDashStyle | ( | $ | style | ) | [protected] |
| getCSSBorderMargin | ( | $ | cssbspace, |
| $ | width = 0 |
||
| ) |
Get the border-spacing from CSS attribute.
| $cssbspace | (string) border-spacing CSS properties |
| $width | (float) width of the containing element |
Definition at line 20466 of file tcpdf.php.
| getCSSBorderStyle | ( | $ | cssborder | ) | [protected] |
Returns the border style array from CSS border properties
| $cssborder | (string) border properties |
Definition at line 20307 of file tcpdf.php.
| getCSSBorderWidth | ( | $ | width | ) | [protected] |
| getCSSdataArray | ( | $ | dom, |
| $ | key, | ||
| $ | css | ||
| ) | [protected] |
Returns the styles array that apply for the selected HTML tag.
| $dom | (array) array of HTML tags and properties |
| $key | (int) key of the current HTML tag |
| $css | (array) array of CSS properties |
Definition at line 20175 of file tcpdf.php.
| getCSSFontSpacing | ( | $ | spacing, |
| $ | parent = 0 |
||
| ) | [protected] |
Returns the letter-spacing value from CSS value
| $spacing | (string) letter-spacing value |
| $parent | (float) font spacing (tracking/kerning) value of the parent element |
Definition at line 20500 of file tcpdf.php.
| getCSSFontStretching | ( | $ | stretch, |
| $ | parent = 100 |
||
| ) | [protected] |
Returns the percentage of font stretching from CSS value
| $stretch | (string) stretch mode |
| $parent | (float) stretch value of the parent element |
Definition at line 20531 of file tcpdf.php.
| getCSSMargin | ( | $ | cssmargin, |
| $ | width = 0 |
||
| ) |
Get the internal Cell margin from CSS attribute.
| $cssmargin | (string) margin properties |
| $width | (float) width of the containing element |
Definition at line 20412 of file tcpdf.php.
| getCSSPadding | ( | $ | csspadding, |
| $ | width = 0 |
||
| ) |
Get the internal Cell padding from CSS attribute.
| $csspadding | (string) padding properties |
| $width | (float) width of the containing element |
Definition at line 20358 of file tcpdf.php.
| getDestination | ( | ) |
| getEncPermissionsString | ( | $ | protection | ) | [protected] |
| getFontAscent | ( | $ | font, |
| $ | style = '', |
||
| $ | size = 0 |
||
| ) |
Return the font ascent value
| $font | (string) font name |
| $style | (string) font style |
| $size | (float) The size (in points) |
Definition at line 5288 of file tcpdf.php.
| getFontBuffer | ( | $ | font | ) | [protected] |
| getFontDescent | ( | $ | font, |
| $ | style = '', |
||
| $ | size = 0 |
||
| ) |
Return the font descent value
| $font | (string) font name |
| $style | (string) font style |
| $size | (float) The size (in points) |
Definition at line 5267 of file tcpdf.php.
| getFontFamily | ( | ) |
| getFontFamilyName | ( | $ | fontfamily | ) |
| getFontSize | ( | ) |
| getFontSizePt | ( | ) |
| getFontsList | ( | ) | [protected] |
| getFontSpacing | ( | ) |
| getFontStyle | ( | ) |
| getFooterFont | ( | ) |
| getFooterMargin | ( | ) |
| getGDgamma | ( | $ | v | ) | [protected] |
| getGraphicVars | ( | ) | [protected] |
| getGroupPageNo | ( | ) |
Returns the current group page number formatted as a string.
Definition at line 17809 of file tcpdf.php.
| getHeaderData | ( | ) |
Returns header data:
Definition at line 4052 of file tcpdf.php.
| getHeaderFont | ( | ) |
| getHeaderMargin | ( | ) |
| getHtmlDomArray | ( | $ | html | ) | [protected] |
| getHTMLUnitToUnits | ( | $ | htmlval, |
| $ | refsize = 1, |
||
| $ | defaultunit = 'px', |
||
| $ | points = false |
||
| ) |
Convert HTML string containing value and unit of measure to user's units or points.
| $htmlval | (string) string containing values and unit |
| $refsize | (string) reference value in points |
| $defaultunit | (string) default unit (can be one of the following: %, em, ex, px, in, mm, pc, pt). |
| $points | (boolean) if true returns points, otherwise returns value in user's units |
Definition at line 24505 of file tcpdf.php.
| getHyphenPatternsFromTEX | ( | $ | file | ) |
Returns an array of hyphenation patterns.
| $file | (string) TEX file containing hypenation patterns. TEX pattrns can be downloaded from http://www.ctan.org/tex-archive/language/hyph-utf8/tex/generic/hyph-utf8/patterns/ |
Definition at line 26337 of file tcpdf.php.
| getImageBuffer | ( | $ | image | ) | [protected] |
| getImageFileType | ( | $ | imgfile, |
| $ | iminfo = array() |
||
| ) |
Return the image type given the file name or array returned by getimagesize() function.
| $imgfile | (string) image file name |
| $iminfo | (array) array of image information returned by getimagesize() function. |
Definition at line 7341 of file tcpdf.php.
| getImageRBX | ( | ) |
| getImageRBY | ( | ) |
| getImageScale | ( | ) |
| getInternalPageNumberAliases | ( | $ | a = '' | ) | [protected] |
| getLastH | ( | ) |
| GetLineWidth | ( | ) |
Returns the current the line width.
Definition at line 14624 of file tcpdf.php.
| getMargins | ( | ) |
Returns an array containing current margins:
| GetNumChars | ( | $ | s | ) |
| getNumLines | ( | $ | txt, |
| $ | w = 0, |
||
| $ | reseth = false, |
||
| $ | autopadding = true, |
||
| $ | cellpadding = '', |
||
| $ | border = 0 |
||
| ) |
This method return the estimated number of lines for print a simple text string using Multicell() method.
| $txt | (string) String for calculating his height |
| $w | (float) Width of cells. If 0, they extend up to the right margin of the page. |
| $reseth | (boolean) if true reset the last cell height (default false). |
| $autopadding | (boolean) if true, uses internal padding and automatically adjust it to account for line width (default true). |
| $cellpadding | (float) Internal cell padding, if empty uses default cell padding. |
| $border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
Definition at line 6692 of file tcpdf.php.
| getNumPages | ( | ) |
| getObjFilename | ( | $ | name | ) | [protected] |
| getPage | ( | ) |
Get current document page number.
Definition at line 3836 of file tcpdf.php.
| getPageBuffer | ( | $ | page | ) | [protected] |
| getPageDimensions | ( | $ | pagenum = '' | ) |
Returns an array of page dimensions:
| $pagenum | (int) page number (empty = current page) |
Return the alias for the total number of pages in the current page group. If the current font is unicode type, the returned string is surrounded by additional curly braces. This alias will be replaced by the total number of pages in this group.
Definition at line 17771 of file tcpdf.php.
| getPageHeight | ( | $ | pagenum = '' | ) |
Returns the page height in units.
| $pagenum | (int) page number (empty = current page) |
Return the alias for the page number on the current page group. If the current font is unicode type, the returned string is surrounded by additional curly braces. This alias will be replaced by the page number (relative to the belonging group).
Definition at line 17786 of file tcpdf.php.
| getPageRegions | ( | ) |
Return an array of no-write page regions
| getPageSizeFromFormat | ( | $ | format | ) |
Get page dimensions from format name.
| $format | (mixed) The format name. It can be:
|
Definition at line 2384 of file tcpdf.php.
| getPageWidth | ( | $ | pagenum = '' | ) |
Returns the page width in units.
| $pagenum | (int) page number (empty = current page) |
| getPathPaintOperator | ( | $ | style, |
| $ | default = 'S' |
||
| ) | [protected] |
Get the Path-Painting Operators.
| $style | (string) Style of rendering. Possible values are:
|
| $default | (string) default style |
Definition at line 26447 of file tcpdf.php.
| getPDFData | ( | ) |
| getRandomSeed | ( | $ | seed = '' | ) | [protected] |
| getRawCharWidth | ( | $ | char | ) |
| getRemainingWidth | ( | ) | [protected] |
| getRTL | ( | ) |
| getScaleFactor | ( | ) |
| getSignatureAppearanceArray | ( | $ | x = 0, |
| $ | y = 0, |
||
| $ | w = 0, |
||
| $ | h = 0, |
||
| $ | page = -1 |
||
| ) | [protected] |
Get the array that defines the signature appearance (page and rectangle coordinates).
| $x | (float) Abscissa of the upper-left corner. |
| $y | (float) Ordinate of the upper-left corner. |
| $w | (float) Width of the signature area. |
| $h | (float) Height of the signature area. |
| $page | (int) option page number (if < 0 the current page is used). |
Definition at line 17656 of file tcpdf.php.
| getSpaceString | ( | ) | [protected] |
| getSpotColor | ( | $ | name | ) |
| getStringHeight | ( | $ | w, |
| $ | txt, | ||
| $ | reseth = false, |
||
| $ | autopadding = true, |
||
| $ | cellpadding = '', |
||
| $ | border = 0 |
||
| ) |
This method return the estimated height needed for printing a simple text string using the Multicell() method. Generally, if you want to know the exact height for a block of content you can use the following alternative technique:
| $w | (float) Width of cells. If 0, they extend up to the right margin of the page. |
| $txt | (string) String for calculating his height |
| $reseth | (boolean) if true reset the last cell height (default false). |
| $autopadding | (boolean) if true, uses internal padding and automatically adjust it to account for line width (default true). |
| $cellpadding | (float) Internal cell padding, if empty uses default cell padding. |
| $border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
Definition at line 6798 of file tcpdf.php.
| GetStringWidth | ( | $ | s, |
| $ | fontname = '', |
||
| $ | fontstyle = '', |
||
| $ | fontsize = 0, |
||
| $ | getarray = false |
||
| ) |
Returns the length of a string in user unit. A font must be selected.
| $s | (string) The string whose length is to be computed |
| $fontname | (string) Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained. |
| $fontstyle | (string) Font style. Possible values are (case insensitive):
|
| $fontsize | (float) Font size in points. The default value is the current size. |
| $getarray | (boolean) if true returns an array of characters widths, if false returns the total length. |
Definition at line 4797 of file tcpdf.php.
| getSVGTransformMatrix | ( | $ | attribute | ) | [protected] |
| getTagStyleFromCSSarray | ( | $ | css | ) | [protected] |
| getTCPDFVersion | ( | ) |
| getTransformationMatrixProduct | ( | $ | ta, |
| $ | tb | ||
| ) | [protected] |
| getUserPermissionCode | ( | $ | permissions, |
| $ | mode = 0 |
||
| ) | [protected] |
Return the premission code used on encryption (P value).
| $permissions | (Array) the set of permissions (specify the ones you want to block). |
| $mode | (int) encryption strength: 0 = RC4 40 bit; 1 = RC4 128 bit; 2 = AES 128 bit; 3 = AES 256 bit. |
Definition at line 14080 of file tcpdf.php.
| getVectorsAngle | ( | $ | x1, |
| $ | y1, | ||
| $ | x2, | ||
| $ | y2 | ||
| ) | [protected] |
Returns the angle in radiants between two vectors
| $x1 | (int) X coordinate of first vector point |
| $y1 | (int) Y coordinate of first vector point |
| $x2 | (int) X coordinate of second vector point |
| $y2 | (int) Y coordinate of second vector point |
Definition at line 28171 of file tcpdf.php.
| GetX | ( | ) |
| GetY | ( | ) |
Output gradient.
| $type | (int) type of gradient (1 Function-based shading; 2 Axial shading; 3 Radial shading; 4 Free-form Gouraud-shaded triangle mesh; 5 Lattice-form Gouraud-shaded triangle mesh; 6 Coons patch mesh; 7 Tensor-product patch mesh). (Not all types are currently supported) |
| $coords | (array) array of coordinates. |
| $stops | (array) array gradient color components: color = array of GRAY, RGB or CMYK color components; offset = (0 to 1) represents a location along the gradient vector; exponent = exponent of the exponential interpolation function (default = 1). |
| $background | (array) An array of colour components appropriate to the colour space, specifying a single background colour value. |
| $antialias | (boolean) A flag indicating whether to filter the shading function to prevent aliasing artifacts. |
Definition at line 18458 of file tcpdf.php.
| Header | ( | ) |
| hyphenateText | ( | $ | text, |
| $ | patterns, | ||
| $ | dictionary = array(), |
||
| $ | leftmin = 1, |
||
| $ | rightmin = 2, |
||
| $ | charmin = 1, |
||
| $ | charmax = 8 |
||
| ) |
Returns text with soft hyphens.
| $text | (string) text to process |
| $patterns | (mixed) Array of hypenation patterns or a TEX file containing hypenation patterns. TEX patterns can be downloaded from http://www.ctan.org/tex-archive/language/hyph-utf8/tex/generic/hyph-utf8/patterns/ |
| $dictionary | (array) Array of words to be returned without applying the hyphenation algoritm. |
| $leftmin | (int) Minimum number of character to leave on the left of the word without applying the hyphens. |
| $rightmin | (int) Minimum number of character to leave on the right of the word without applying the hyphens. |
| $charmin | (int) Minimum word length to apply the hyphenation algoritm. |
| $charmax | (int) Maximum length of broken piece of word. |
Definition at line 26376 of file tcpdf.php.
| hyphenateWord | ( | $ | word, |
| $ | patterns, | ||
| $ | dictionary = array(), |
||
| $ | leftmin = 1, |
||
| $ | rightmin = 2, |
||
| $ | charmin = 1, |
||
| $ | charmax = 8 |
||
| ) | [protected] |
Returns an array of chars containing soft hyphens.
| $word | (array) array of chars |
| $patterns | (array) Array of hypenation patterns. |
| $dictionary | (array) Array of words to be returned without applying the hyphenation algoritm. |
| $leftmin | (int) Minimum number of character to leave on the left of the word without applying the hyphens. |
| $rightmin | (int) Minimum number of character to leave on the right of the word without applying the hyphens. |
| $charmin | (int) Minimum word length to apply the hyphenation algoritm. |
| $charmax | (int) Maximum length of broken piece of word. |
Definition at line 26267 of file tcpdf.php.
| Image | ( | $ | file, |
| $ | x = '', |
||
| $ | y = '', |
||
| $ | w = 0, |
||
| $ | h = 0, |
||
| $ | type = '', |
||
| $ | link = '', |
||
| $ | align = '', |
||
| $ | resize = false, |
||
| $ | dpi = 300, |
||
| $ | palign = '', |
||
| $ | ismask = false, |
||
| $ | imgmask = false, |
||
| $ | border = 0, |
||
| $ | fitbox = false, |
||
| $ | hidden = false, |
||
| $ | fitonpage = false, |
||
| $ | alt = false, |
||
| $ | altimgs = array() |
||
| ) |
Puts an image in the page. The upper-left corner must be given. The dimensions can be specified in different ways:
Supported formats are JPEG and PNG images whitout GD library and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM; The format can be specified explicitly or inferred from the file extension.
It is possible to put a link on the image.
Remark: if an image is used several times, only one copy will be embedded in the file.
| $file | (string) Name of the file containing the image or a '@' character followed by the image data string. To link an image without embedding it on the document, set an asterisk character before the URL (i.e.: '*http://www.example.com/image.jpg'). |
| $x | (float) Abscissa of the upper-left corner (LTR) or upper-right corner (RTL). |
| $y | (float) Ordinate of the upper-left corner (LTR) or upper-right corner (RTL). |
| $w | (float) Width of the image in the page. If not specified or equal to zero, it is automatically calculated. |
| $h | (float) Height of the image in the page. If not specified or equal to zero, it is automatically calculated. |
| $type | (string) Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension. |
| $link | (mixed) URL or identifier returned by AddLink(). |
| $align | (string) Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:
|
| $resize | (mixed) If true resize (reduce) the image to fit $w and $h (requires GD or ImageMagick library); if false do not resize; if 2 force resize in all cases (upscaling and downscaling). |
| $dpi | (int) dot-per-inch resolution used on resize |
| $palign | (string) Allows to center or align the image on the current line. Possible values are:
|
| $ismask | (boolean) true if this image is a mask, false otherwise |
| $imgmask | (mixed) image object returned by this function or false |
| $border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
| $fitbox | (mixed) If not false scale image dimensions proportionally to fit within the ($w, $h) box. $fitbox can be true or a 2 characters string indicating the image alignment inside the box. The first character indicate the horizontal alignment (L = left, C = center, R = right) the second character indicate the vertical algnment (T = top, M = middle, B = bottom). |
| $hidden | (boolean) If true do not display the image. |
| $fitonpage | (boolean) If true the image is resized to not exceed page dimensions. |
| $alt | (boolean) If true the image will be added as alternative and not directly printed (the ID of the image will be returned). |
| $altimgs | (array) Array of alternate images IDs. Each alternative image must be an array with two values: an integer representing the image ID (the value returned by the Image method) and a boolean value to indicate if the image is the default for printing. |
Definition at line 7461 of file tcpdf.php.
| ImageEps | ( | $ | file, |
| $ | x = '', |
||
| $ | y = '', |
||
| $ | w = 0, |
||
| $ | h = 0, |
||
| $ | link = '', |
||
| $ | useBoundingBox = true, |
||
| $ | align = '', |
||
| $ | palign = '', |
||
| $ | border = 0, |
||
| $ | fitonpage = false, |
||
| $ | fixoutvals = false |
||
| ) |
Embed vector-based Adobe Illustrator (AI) or AI-compatible EPS files. NOTE: EPS is not yet fully implemented, use the setRasterizeVectorImages() method to enable/disable rasterization of vector images using ImageMagick library. Only vector drawing is supported, not text or bitmap. Although the script was successfully tested with various AI format versions, best results are probably achieved with files that were exported in the AI3 format (tested with Illustrator CS2, Freehand MX and Photoshop CS2).
| $file | (string) Name of the file containing the image or a '@' character followed by the EPS/AI data string. |
| $x | (float) Abscissa of the upper-left corner. |
| $y | (float) Ordinate of the upper-left corner. |
| $w | (float) Width of the image in the page. If not specified or equal to zero, it is automatically calculated. |
| $h | (float) Height of the image in the page. If not specified or equal to zero, it is automatically calculated. |
| $link | (mixed) URL or identifier returned by AddLink(). |
| $useBoundingBox | (boolean) specifies whether to position the bounding box (true) or the complete canvas (false) at location (x,y). Default value is true. |
| $align | (string) Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:
|
| $palign | (string) Allows to center or align the image on the current line. Possible values are:
|
| $border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
| $fitonpage | (boolean) if true the image is resized to not exceed page dimensions. |
| $fixoutvals | (boolean) if true remove values outside the bounding box. |
Definition at line 18817 of file tcpdf.php.
| 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 GD library.
| $file | (string) Name of the file containing the image. |
| $x | (float) Abscissa of the upper-left corner. |
| $y | (float) Ordinate of the upper-left corner. |
| $wpx | (float) Original width of the image in pixels. |
| $hpx | (float) original height of the image in pixels. |
| $w | (float) Width of the image in the page. If not specified or equal to zero, it is automatically calculated. |
| $h | (float) Height of the image in the page. If not specified or equal to zero, it is automatically calculated. |
| $type | (string) Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension. |
| $link | (mixed) URL or identifier returned by AddLink(). |
| $align | (string) Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:
|
| $resize | (boolean) If true resize (reduce) the image to fit $w and $h (requires GD library). |
| $dpi | (int) dot-per-inch resolution used on resize |
| $palign | (string) Allows to center or align the image on the current line. Possible values are:
|
| $filehash | (string) File hash used to build unique file names. |
Definition at line 8208 of file tcpdf.php.
| ImageSVG | ( | $ | file, |
| $ | x = '', |
||
| $ | y = '', |
||
| $ | w = 0, |
||
| $ | h = 0, |
||
| $ | link = '', |
||
| $ | align = '', |
||
| $ | palign = '', |
||
| $ | border = 0, |
||
| $ | fitonpage = false |
||
| ) |
Embedd a Scalable Vector Graphics (SVG) image. NOTE: SVG standard is not yet fully implemented, use the setRasterizeVectorImages() method to enable/disable rasterization of vector images using ImageMagick library.
| $file | (string) Name of the SVG file or a '@' character followed by the SVG data string. |
| $x | (float) Abscissa of the upper-left corner. |
| $y | (float) Ordinate of the upper-left corner. |
| $w | (float) Width of the image in the page. If not specified or equal to zero, it is automatically calculated. |
| $h | (float) Height of the image in the page. If not specified or equal to zero, it is automatically calculated. |
| $link | (mixed) URL or identifier returned by AddLink(). |
| $align | (string) Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:
|
| $palign | (string) Allows to center or align the image on the current line. Possible values are:
|
| $border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
| $fitonpage | (boolean) if true the image is resized to not exceed page dimensions. |
Definition at line 27084 of file tcpdf.php.
| IncludeJS | ( | $ | script | ) |
| inPageBody | ( | ) | [protected] |
| intToRoman | ( | $ | number | ) |
| isRTLTextDir | ( | ) |
| isUnicodeFont | ( | ) |
| isValidCSSSelectorForTag | ( | $ | dom, |
| $ | key, | ||
| $ | selector | ||
| ) | [protected] |
Returns true if the CSS selector is valid for the selected HTML tag
| $dom | (array) array of HTML tags and properties |
| $key | (int) key of the current HTML tag |
| $selector | (string) CSS selector string |
Definition at line 20015 of file tcpdf.php.
| lastPage | ( | $ | resetmargins = false | ) |
Reset pointer to the last document page.
| $resetmargins | (boolean) if true reset left, right, top margins and Y position. |
Definition at line 3825 of file tcpdf.php.
Draws a line between two points.
| $x1 | (float) Abscissa of first point. |
| $y1 | (float) Ordinate of first point. |
| $x2 | (float) Abscissa of second point. |
| $y2 | (float) Ordinate of second point. |
| $style | (array) Line style. Array like for SetLineStyle(). Default value: default line style (empty array). |
Definition at line 14798 of file tcpdf.php.
| LinearGradient | ( | $ | x, |
| $ | y, | ||
| $ | w, | ||
| $ | h, | ||
| $ | col1 = array(), |
||
| $ | col2 = array(), |
||
| $ | coords = array(0,0,1,0) |
||
| ) |
Paints a linear colour gradient.
| $x | (float) abscissa of the top left corner of the rectangle. |
| $y | (float) ordinate of the top left corner of the rectangle. |
| $w | (float) width of the rectangle. |
| $h | (float) height of the rectangle. |
| $col1 | (array) first color (Grayscale, RGB or CMYK components). |
| $col2 | (array) second color (Grayscale, RGB or CMYK components). |
| $coords | (array) array of the form (x1, y1, x2, y2) which defines the gradient vector (see linear_gradient_coords.jpg). The default value is from left to right (x1=0, y1=0, x2=1, y2=0). |
Definition at line 18301 of file tcpdf.php.
| Link | ( | $ | x, |
| $ | y, | ||
| $ | w, | ||
| $ | h, | ||
| $ | link, | ||
| $ | spaces = 0 |
||
| ) |
Puts a link on a rectangular area of the page. Text or image links are generally put via Cell(), Write() or Image(), but this method can be useful for instance to define a clickable area inside an image.
| $x | (float) Abscissa of the upper-left corner of the rectangle |
| $y | (float) Ordinate of the upper-left corner of the rectangle |
| $w | (float) Width of the rectangle |
| $h | (float) Height of the rectangle |
| $link | (mixed) URL or identifier returned by AddLink() |
| $spaces | (int) number of spaces on the text to link |
Definition at line 5355 of file tcpdf.php.
| ListBox | ( | $ | name, |
| $ | w, | ||
| $ | h, | ||
| $ | values, | ||
| $ | prop = array(), |
||
| $ | opt = array(), |
||
| $ | x = '', |
||
| $ | y = '', |
||
| $ | js = false |
||
| ) |
Creates a List-box field
| $name | (string) field name |
| $w | (int) width |
| $h | (int) height |
| $values | (array) array containing the list of values. |
| $prop | (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
| $opt | (array) annotation parameters. Possible values are described on official PDF32000_2008 reference. |
| $x | (float) Abscissa of the upper-left corner of the rectangle |
| $y | (float) Ordinate of the upper-left corner of the rectangle |
| $js | (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered). |
Definition at line 17069 of file tcpdf.php.
| Ln | ( | $ | h = '', |
| $ | cell = false |
||
| ) |
Performs a line break. The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.
| $h | (float) The height of the break. By default, the value equals the height of the last printed cell. |
| $cell | (boolean) if true add the current left (or right o for RTL) padding to the X coordinate |
Definition at line 8287 of file tcpdf.php.
| MirrorH | ( | $ | x = '' | ) |
Horizontal Mirroring.
| $x | (int) abscissa of the point. Default is current x position |
Definition at line 14398 of file tcpdf.php.
| MirrorL | ( | $ | angle = 0, |
| $ | x = '', |
||
| $ | y = '' |
||
| ) |
Reflection against a straight line through point (x, y) with the gradient angle (angle).
| $angle | (float) gradient angle of the straight line. Default is 0 (horizontal line). |
| $x | (int) abscissa of the point. Default is current x position |
| $y | (int) ordinate of the point. Default is current y position |
Definition at line 14434 of file tcpdf.php.
| MirrorP | ( | $ | x = '', |
| $ | y = '' |
||
| ) |
Point reflection mirroring.
| $x | (int) abscissa of the point. Default is current x position |
| $y | (int) ordinate of the point. Default is current y position |
Definition at line 14421 of file tcpdf.php.
| MirrorV | ( | $ | y = '' | ) |
Verical Mirroring.
| $y | (int) ordinate of the point. Default is current y position |
Definition at line 14409 of file tcpdf.php.
| movePage | ( | $ | frompage, |
| $ | topage | ||
| ) |
Move a page to a previous position.
| $frompage | (int) number of the source page |
| $topage | (int) number of the destination page (must be less than $frompage) |
Definition at line 25238 of file 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.
| $w | (float) Width of cells. If 0, they extend up to the right margin of the page. |
| $h | (float) Cell minimum height. The cell extends automatically if needed. |
| $txt | (string) String to print |
| $border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
| $align | (string) Allows to center or align the text. Possible values are:
|
| $fill | (boolean) Indicates if the cell background must be painted (true) or transparent (false). |
| $ln | (int) Indicates where the current position should go after the call. Possible values are:
|
| $x | (float) x position in user units |
| $y | (float) y position in user units |
| $reseth | (boolean) if true reset the last cell height (default true). |
| $stretch | (int) font stretch mode:
|
| $ishtml | (boolean) INTERNAL USE ONLY -- set to true if $txt is HTML content (default = false). Never set this parameter to true, use instead writeHTMLCell() or writeHTML() methods. |
| $autopadding | (boolean) if true, uses internal padding and automatically adjust it to account for line width. |
| $maxh | (float) maximum height. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature. This feature works only when $ishtml=false. |
| $valign | (string) Vertical alignment of text (requires $maxh = $h > 0). Possible values are:
|
| $fitcell | (boolean) if true attempt to fit all the text within the cell by reducing the font size (do not work in HTML mode). |
Definition at line 6280 of file tcpdf.php.
| objclone | ( | $ | object | ) |
| Open | ( | ) |
| openHTMLTagHandler | ( | $ | dom, |
| $ | key, | ||
| $ | cell | ||
| ) | [protected] |
Process opening tags.
| $dom | (array) html dom array |
| $key | (int) current element id |
| $cell | (boolean) if true add the default left (or right if RTL) padding to each new line (default false). |
Definition at line 22940 of file tcpdf.php.
| Output | ( | $ | name = 'doc.pdf', |
| $ | dest = 'I' |
||
| ) |
Send the document to a given destination: string, local file or browser. In the last case, the plug-in may be used (if present) or a download ("Save as" dialog box) may be forced.
The method first calls Close() if necessary to terminate the document.
| $name | (string) The name of the file when saved. Note that special characters are removed and blanks characters are replaced with the underscore character. |
| $dest | (string) Destination where to send the document. It can take one of the following values:
|
Reimplemented in pdf.
Definition at line 8456 of file tcpdf.php.
| PageNo | ( | ) |
Returns the current page number.
Definition at line 4443 of file tcpdf.php.
| PageNoFormatted | ( | ) |
Returns the current page number formatted as a string.
Definition at line 17842 of file tcpdf.php.
Draw the sector of a circle. It can be used for instance to render pie charts.
| $xc | (float) abscissa of the center. |
| $yc | (float) ordinate of the center. |
| $r | (float) radius. |
| $a | (float) start angle (in degrees). |
| $b | (float) end angle (in degrees). |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $cw,: | (float) indicates whether to go clockwise (default: true). |
| $o,: | (float) origin of angles (0 for 3 o'clock, 90 for noon, 180 for 9 o'clock, 270 for 6 o'clock). Default: 90. |
Definition at line 18755 of file tcpdf.php.
| PieSectorXY | ( | $ | xc, |
| $ | yc, | ||
| $ | rx, | ||
| $ | ry, | ||
| $ | a, | ||
| $ | b, | ||
| $ | style = 'FD', |
||
| $ | cw = false, |
||
| $ | o = 0, |
||
| $ | nc = 2 |
||
| ) |
Draw the sector of an ellipse. It can be used for instance to render pie charts.
| $xc | (float) abscissa of the center. |
| $yc | (float) ordinate of the center. |
| $rx | (float) the x-axis radius. |
| $ry | (float) the y-axis radius. |
| $a | (float) start angle (in degrees). |
| $b | (float) end angle (in degrees). |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $cw,: | (float) indicates whether to go clockwise. |
| $o,: | (float) origin of angles (0 for 3 o'clock, 90 for noon, 180 for 9 o'clock, 270 for 6 o'clock). |
| $nc | (integer) Number of curves used to draw a 90 degrees portion of arc. |
Definition at line 18776 of file tcpdf.php.
| pixelsToUnits | ( | $ | px | ) |
Converts pixels to User's Units.
| $px | (int) pixels |
Definition at line 13533 of file tcpdf.php.
Draws a poly-Bezier curve. Each Bezier curve segment is a tangent to the line between the control points at either end of the curve.
| $x0 | (float) Abscissa of start point. |
| $y0 | (float) Ordinate of start point. |
| $segments | (float) An array of bezier descriptions. Format: array(x1, y1, x2, y2, x3, y3). |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $line_style | (array) Line style of curve. Array like for SetLineStyle(). Default value: default line style (empty array). |
| $fill_color | (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array). |
Definition at line 14908 of file tcpdf.php.
Draws a polygon.
| $p | (array) Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1)) |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $line_style | (array) Line style of polygon. Array with keys among the following:
|
| $fill_color | (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array). |
| $closed | (boolean) if true the polygon is closes, otherwise will remain open |
Definition at line 15148 of file tcpdf.php.
Draws a polygonal line
| $p | (array) Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1)) |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $line_style | (array) Line style of polygon. Array with keys among the following:
|
| $fill_color | (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K). Default value: default color (empty array). |
Definition at line 15129 of file tcpdf.php.
| printTemplate | ( | $ | id, |
| $ | x = '', |
||
| $ | y = '', |
||
| $ | w = 0, |
||
| $ | h = 0, |
||
| $ | align = '', |
||
| $ | palign = '', |
||
| $ | fitonpage = false |
||
| ) |
Print an XObject Template. You can print an XObject Template inside the currently opened Template. An XObject Template is a PDF block that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images). An XObject Template may be painted multiple times, either on several pages or at several locations on the same page and produces the same results each time, subject only to the graphics state at the time it is invoked.
| $id | (string) The ID of XObject Template to print. |
| $x | (int) X position in user units (empty string = current x position) |
| $y | (int) Y position in user units (empty string = current y position) |
| $w | (int) Width in user units (zero = remaining page width) |
| $h | (int) Height in user units (zero = remaining page height) |
| $align | (string) Indicates the alignment of the pointer next to template insertion relative to template height. The value can be:
|
| $palign | (string) Allows to center or align the template on the current line. Possible values are:
|
| $fitonpage | (boolean) If true the template is resized to not exceed page dimensions. |
Definition at line 26740 of file tcpdf.php.
| putHtmlListBullet | ( | $ | listdepth, |
| $ | listtype = '', |
||
| $ | size = 10 |
||
| ) | [protected] |
Output an HTML list bullet or ordered item symbol
| $listdepth | (int) list nesting level |
| $listtype | (string) type of list |
| $size | (float) current font size |
Definition at line 24649 of file tcpdf.php.
| RadialGradient | ( | $ | x, |
| $ | y, | ||
| $ | w, | ||
| $ | h, | ||
| $ | col1 = array(), |
||
| $ | col2 = array(), |
||
| $ | coords = array(0.5,0.5,0.5,0.5,1) |
||
| ) |
Paints a radial colour gradient.
| $x | (float) abscissa of the top left corner of the rectangle. |
| $y | (float) ordinate of the top left corner of the rectangle. |
| $w | (float) width of the rectangle. |
| $h | (float) height of the rectangle. |
| $col1 | (array) first color (Grayscale, RGB or CMYK components). |
| $col2 | (array) second color (Grayscale, RGB or CMYK components). |
| $coords | (array) array of the form (fx, fy, cx, cy, r) where (fx, fy) is the starting point of the gradient with color1, (cx, cy) is the center of the circle with color2, and r is the radius of the circle (see radial_gradient_coords.jpg). (fx, fy) should be inside the circle, otherwise some areas will not be defined. |
Definition at line 18319 of file tcpdf.php.
| RadioButton | ( | $ | name, |
| $ | w, | ||
| $ | prop = array(), |
||
| $ | opt = array(), |
||
| $ | onvalue = 'On', |
||
| $ | checked = false, |
||
| $ | x = '', |
||
| $ | y = '', |
||
| $ | js = false |
||
| ) |
Creates a RadioButton field.
| $name | (string) Field name. |
| $w | (int) Width or the radio button. |
| $prop | (array) Javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
| $opt | (array) Annotation parameters. Possible values are described on official PDF32000_2008 reference. |
| $onvalue | (string) Value to be returned if selected. |
| $checked | (boolean) Define the initial state. |
| $x | (float) Abscissa of the upper-left corner of the rectangle |
| $y | (float) Ordinate of the upper-left corner of the rectangle |
| $js | (boolean) If true put the field using JavaScript (requires Acrobat Writer to be rendered). |
Definition at line 16971 of file tcpdf.php.
| readDiskCache | ( | $ | filename | ) | [protected] |
Draws a rectangle.
| $x | (float) Abscissa of upper-left corner. |
| $y | (float) Ordinate of upper-left corner. |
| $w | (float) Width. |
| $h | (float) Height. |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $border_style | (array) Border style of rectangle. Array with keys among the following:
|
| $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). Default value: default color (empty array). |
Definition at line 14826 of file tcpdf.php.
| registrationMark | ( | $ | x, |
| $ | y, | ||
| $ | r, | ||
| $ | double = false, |
||
| $ | cola = array(0,0,0), |
||
| $ | colb = array(255,255,255) |
||
| ) |
Paints a registration mark
| $x | (float) abscissa of the registration mark center. |
| $y | (float) ordinate of the registration mark center. |
| $r | (float) radius of the crop mark. |
| $double | (boolean) if true print two concentric crop marks. |
| $cola | (array) crop mark color (default black). |
| $colb | (array) second crop mark color. |
Definition at line 18270 of file tcpdf.php.
| RegularPolygon | ( | $ | x0, |
| $ | y0, | ||
| $ | r, | ||
| $ | ns, | ||
| $ | angle = 0, |
||
| $ | draw_circle = false, |
||
| $ | style = '', |
||
| $ | line_style = array(), |
||
| $ | fill_color = array(), |
||
| $ | circle_style = '', |
||
| $ | circle_outLine_style = array(), |
||
| $ | circle_fill_color = array() |
||
| ) |
Draws a regular polygon.
| $x0 | (float) Abscissa of center point. |
| $y0 | (float) Ordinate of center point. |
| $r,: | (float) Radius of inscribed circle. |
| $ns | (integer) Number of sides. |
| $angle | (float) Angle oriented (anti-clockwise). Default value: 0. |
| $draw_circle | (boolean) Draw inscribed circle or not. Default value: false. |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $line_style | (array) Line style of polygon sides. Array with keys among the following:
|
| $fill_color | (array) Fill color. Format: array(red, green, blue). Default value: default color (empty array). |
| $circle_style | (string) Style of rendering of inscribed circle (if draws). Possible values are:
|
| $circle_outLine_style | (array) Line style of inscribed circle (if draws). Array like for SetLineStyle(). Default value: default line style (empty array). |
| $circle_fill_color | (array) Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array). |
Definition at line 15246 of file tcpdf.php.
| removePageRegion | ( | $ | key | ) |
Remove a single no-write region.
| $key | (int) region key |
| removeSHY | ( | $ | txt = '' | ) |
Removes SHY characters from text. Unicode Data:
| $txt | (string) input string |
Definition at line 5605 of file tcpdf.php.
| replaceBuffer | ( | $ | data | ) | [protected] |
| replacePageNumAliases | ( | $ | page, |
| $ | replace, | ||
| $ | diff = 0 |
||
| ) | [protected] |
Replace page number aliases with number.
| $page | (string) Page content. |
| $replace | (array) Array of replacements (array keys are replacement strings, values are alias arrays). |
| $diff | (int) If passed, this will be set to the total char number difference between alias and replacements. |
Definition at line 8759 of file tcpdf.php.
| 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.
| $page | (string) Page content. |
| $aliases | (array) Array of page aliases. |
| $diff | (int) initial difference to add. |
Definition at line 8780 of file tcpdf.php.
| resetColumns | ( | ) |
| resetLastH | ( | ) |
| revstrpos | ( | $ | haystack, |
| $ | needle, | ||
| $ | offset = 0 |
||
| ) |
Find position of last occurrence of a substring in a string
| $haystack | (string) The string to search in. |
| $needle | (string) substring to search. |
| $offset | (int) May be specified to begin searching an arbitrary number of characters into the string. |
Definition at line 26016 of file tcpdf.php.
| rfread | ( | $ | handle, |
| $ | length | ||
| ) | [protected] |
Binary-safe and URL-safe file read. Reads up to length bytes from the file pointer referenced by handle. Reading stops as soon as one of the following conditions is met: length bytes have been read; EOF (end of file) is reached.
| $handle | (resource) |
| $length | (int) |
Definition at line 8175 of file tcpdf.php.
| rollbackTransaction | ( | $ | self = false | ) |
This method allows to undo the latest transaction by returning the latest saved TCPDF object with startTransaction().
| $self | (boolean) if true restores current class object to previous state without the need of reassignment via the returned value. |
Definition at line 25963 of file tcpdf.php.
| Rotate | ( | $ | angle, |
| $ | x = '', |
||
| $ | y = '' |
||
| ) |
Rotate object.
| $angle | (float) angle in degrees for counter-clockwise rotation |
| $x | (int) abscissa of the rotation center. Default is current x position |
| $y | (int) ordinate of the rotation center. Default is current y position |
Definition at line 14491 of file tcpdf.php.
| RoundedRect | ( | $ | x, |
| $ | y, | ||
| $ | w, | ||
| $ | h, | ||
| $ | r, | ||
| $ | round_corner = '1111', |
||
| $ | style = '', |
||
| $ | border_style = array(), |
||
| $ | fill_color = array() |
||
| ) |
Draws a rounded rectangle.
| $x | (float) Abscissa of upper-left corner. |
| $y | (float) Ordinate of upper-left corner. |
| $w | (float) Width. |
| $h | (float) Height. |
| $r | (float) the radius of the circle used to round off the corners of the rectangle. |
| $round_corner | (string) Draws rounded corner or not. String with a 0 (not rounded i-corner) or 1 (rounded i-corner) in i-position. Positions are, in order and begin to 0: top left, top right, bottom right and bottom 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). Default value: default color (empty array). |
Definition at line 15336 of file tcpdf.php.
| RoundedRectXY | ( | $ | x, |
| $ | y, | ||
| $ | w, | ||
| $ | h, | ||
| $ | rx, | ||
| $ | ry, | ||
| $ | round_corner = '1111', |
||
| $ | style = '', |
||
| $ | border_style = array(), |
||
| $ | fill_color = array() |
||
| ) |
Draws a rounded rectangle.
| $x | (float) Abscissa of upper-left corner. |
| $y | (float) Ordinate of upper-left corner. |
| $w | (float) Width. |
| $h | (float) Height. |
| $rx | (float) the x-axis radius of the ellipse used to round off the corners of the rectangle. |
| $ry | (float) the y-axis radius of the ellipse used to round off the corners of the rectangle. |
| $round_corner | (string) Draws rounded corner or not. String with a 0 (not rounded i-corner) or 1 (rounded i-corner) in i-position. Positions are, in order and begin to 0: top left, top right, bottom right and bottom 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). Default value: default color (empty array). |
Definition at line 15355 of file tcpdf.php.
| Scale | ( | $ | s_x, |
| $ | s_y, | ||
| $ | x = '', |
||
| $ | y = '' |
||
| ) |
Vertical and horizontal non-proportional Scaling.
| $s_x | (float) scaling factor for width as percent. 0 is not allowed. |
| $s_y | (float) scaling factor for height as percent. 0 is not allowed. |
| $x | (int) abscissa of the scaling center. Default is current x position |
| $y | (int) ordinate of the scaling center. Default is current y position |
Definition at line 14365 of file tcpdf.php.
| ScaleX | ( | $ | s_x, |
| $ | x = '', |
||
| $ | y = '' |
||
| ) |
Horizontal Scaling.
| $s_x | (float) scaling factor for width as percent. 0 is not allowed. |
| $x | (int) abscissa of the scaling center. Default is current x position |
| $y | (int) ordinate of the scaling center. Default is current y position |
Definition at line 14325 of file tcpdf.php.
| ScaleXY | ( | $ | s, |
| $ | x = '', |
||
| $ | y = '' |
||
| ) |
Vertical and horizontal proportional Scaling.
| $s | (float) scaling factor for width and height as percent. 0 is not allowed. |
| $x | (int) abscissa of the scaling center. Default is current x position |
| $y | (int) ordinate of the scaling center. Default is current y position |
Definition at line 14351 of file tcpdf.php.
| ScaleY | ( | $ | s_y, |
| $ | x = '', |
||
| $ | y = '' |
||
| ) |
Vertical Scaling.
| $s_y | (float) scaling factor for height as percent. 0 is not allowed. |
| $x | (int) abscissa of the scaling center. Default is current x position |
| $y | (int) ordinate of the scaling center. Default is current y position |
Definition at line 14338 of file tcpdf.php.
| segSVGContentHandler | ( | $ | parser, |
| $ | data | ||
| ) | [protected] |
Sets the character data handler function for the XML parser.
| $parser | (resource) The first parameter, parser, is a reference to the XML parser calling the handler. |
| $data | (string) The second parameter, data, contains the character data as a string. |
| selectColumn | ( | $ | col = '' | ) |
Set position at a given column
| $col | (int) column number (from 0 to getNumberOfColumns()-1); empty string = current column. |
Definition at line 26092 of file tcpdf.php.
| sendOutputData | ( | $ | data, |
| $ | length | ||
| ) | [protected] |
| serializeTCPDFtagParameters | ( | $ | pararray | ) |
| set_mqr | ( | $ | mqr | ) |
| setAlpha | ( | $ | alpha, |
| $ | bm = 'Normal' |
||
| ) |
Set alpha for stroking (CA) and non-stroking (ca) operations.
| $alpha | (float) 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 |
Definition at line 18010 of file tcpdf.php.
| SetAuthor | ( | $ | author | ) |
Defines the author of the document.
| $author | (string) The name of the author. |
| SetAutoPageBreak | ( | $ | auto, |
| $ | margin = 0 |
||
| ) |
Enables or disables the automatic page breaking mode. When enabling, the second parameter is the distance from the bottom of the page that defines the triggering limit. By default, the mode is on and the margin is 2 cm.
| $auto | (boolean) Boolean indicating if mode should be on or off. |
| $margin | (float) Distance from the bottom of the page. |
Definition at line 3518 of file tcpdf.php.
| setBarcode | ( | $ | bc = '' | ) |
| SetBooklet | ( | $ | booklet = true, |
| $ | inner = -1, |
||
| $ | outer = -1 |
||
| ) |
| setBookmark | ( | $ | txt, |
| $ | level = 0, |
||
| $ | y = -1, |
||
| $ | page = '', |
||
| $ | style = '', |
||
| $ | color = array(0,0,0) |
||
| ) |
Adds a bookmark - alias for Bookmark().
| $txt | (string) Bookmark description. |
| $level | (int) Bookmark level (minimum value is 0). |
| $y | (float) Y position in user units of the bookmark on the selected page (default = -1 = current position; 0 = page start;). |
| $page | (int) Target page number (leave empty for current page). |
| $style | (string) Font style: B = Bold, I = Italic, BI = Bold + Italic. |
| $color | (array) RGB color array (values from 0 to 255). |
Definition at line 16171 of file tcpdf.php.
| setBuffer | ( | $ | data | ) | [protected] |
| setCellHeightRatio | ( | $ | h | ) |
| setCellMargins | ( | $ | left = '', |
| $ | top = '', |
||
| $ | right = '', |
||
| $ | bottom = '' |
||
| ) |
Set the internal Cell margins.
| $left | (float) left margin |
| $top | (float) top margin |
| $right | (float) right margin |
| $bottom | (float) bottom margin |
Definition at line 3410 of file tcpdf.php.
| SetCellPadding | ( | $ | pad | ) |
Set the same internal Cell padding for top, right, bottom, left-
| $pad | (float) internal padding. |
Definition at line 3355 of file tcpdf.php.
| setCellPaddings | ( | $ | left = '', |
| $ | top = '', |
||
| $ | right = '', |
||
| $ | bottom = '' |
||
| ) |
Set the internal Cell paddings.
| $left | (float) left padding |
| $top | (float) top padding |
| $right | (float) right padding |
| $bottom | (float) bottom padding |
Definition at line 3374 of file tcpdf.php.
| setColor | ( | $ | type, |
| $ | col1 = 0, |
||
| $ | col2 = -1, |
||
| $ | col3 = -1, |
||
| $ | col4 = -1, |
||
| $ | ret = false, |
||
| $ | name = '' |
||
| ) |
Defines the color used by the specified type ('draw', 'fill', 'text').
| $type | (string) Type of object affected by this color: ('draw', 'fill', 'text'). |
| $col1 | (float) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100). |
| $col2 | (float) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100). |
| $col3 | (float) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100). |
| $col4 | (float) KEY (BLACK) color for CMYK (0-100). |
| $ret | (boolean) If true do not send the command. |
| $name | (string) spot color name (if any) |
Definition at line 4657 of file tcpdf.php.
| setColorArray | ( | $ | type, |
| $ | color, | ||
| $ | ret = false |
||
| ) |
Set the color array for the specified type ('draw', 'fill', 'text'). It can be expressed in RGB, CMYK or GRAY SCALE components. The method can be called before the first page is created and the value is retained from page to page.
| $type | (string) Type of object affected by this color: ('draw', 'fill', 'text'). |
| $color | (array) Array of colors (1, 3 or 4 values). |
| $ret | (boolean) If true do not send the PDF command. |
Definition at line 4582 of file tcpdf.php.
| setColumnsArray | ( | $ | columns | ) |
| SetCompression | ( | $ | compress = true | ) |
Activates or deactivates page compression. When activated, the internal representation of each page is compressed, which leads to a compression ratio of about 2 for the resulting document. Compression is on by default. Note: the Zlib extension is required for this feature. If not present, compression will be turned off.
| $compress | (boolean) Boolean indicating if compression must be enabled. |
Definition at line 3619 of file tcpdf.php.
| 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.
| $page | (int) page number (default is the current page) |
Definition at line 4019 of file tcpdf.php.
| SetCreator | ( | $ | creator | ) |
Defines the creator of the document. This is typically the name of the application that generates the PDF.
| $creator | (string) The name of the creator. |
| SetDefaultMonospacedFont | ( | $ | font | ) |
| setDefaultTableColumns | ( | $ | cols = 4 | ) |
| setDestination | ( | $ | name, |
| $ | y = -1, |
||
| $ | page = '' |
||
| ) |
Add a Named Destination. NOTE: destination names are unique, so only last entry will be saved.
| $name | (string) Destination name. |
| $y | (float) Y position in user units of the destiantion on the selected page (default = -1 = current position; 0 = page start;). |
| $page | (int) Target page number (leave empty for current page). |
Definition at line 16111 of file tcpdf.php.
| SetDisplayMode | ( | $ | zoom, |
| $ | layout = 'SinglePage', |
||
| $ | mode = 'UseNone' |
||
| ) |
Defines the way the document is to be displayed by the viewer.
| $zoom | (mixed) The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use.
|
| $layout | (string) The page layout. Possible values are:
|
| $mode | (string) A name object specifying how the document should be displayed when opened:
|
Definition at line 3542 of file tcpdf.php.
| SetDocInfoUnicode | ( | $ | unicode = true | ) |
| SetDrawColor | ( | $ | col1 = 0, |
| $ | col2 = -1, |
||
| $ | col3 = -1, |
||
| $ | col4 = -1, |
||
| $ | ret = false, |
||
| $ | name = '' |
||
| ) |
Defines the color used for all drawing operations (lines, rectangles and cell borders). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
| $col1 | (float) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100). |
| $col2 | (float) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100). |
| $col3 | (float) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100). |
| $col4 | (float) KEY (BLACK) color for CMYK (0-100). |
| $ret | (boolean) If true do not send the command. |
| $name | (string) spot color name (if any) |
Definition at line 4747 of file tcpdf.php.
| SetDrawColorArray | ( | $ | color, |
| $ | ret = false |
||
| ) |
Defines the color used for all drawing operations (lines, rectangles and cell borders). It can be expressed in RGB, CMYK or GRAY SCALE components. The method can be called before the first page is created and the value is retained from page to page.
| $color | (array) Array of colors (1, 3 or 4 values). |
| $ret | (boolean) If true do not send the PDF command. |
Definition at line 4613 of file tcpdf.php.
| SetDrawSpotColor | ( | $ | name, |
| $ | tint = 100 |
||
| ) |
Defines the spot color used for all drawing operations (lines, rectangles and cell borders).
| $name | (string) Name of the spot color. |
| $tint | (float) Intensity of the color (from 0 to 100 ; 100 = full intensity by default). |
Definition at line 4543 of file tcpdf.php.
| setEqualColumns | ( | $ | numcols = 0, |
| $ | width = 0, |
||
| $ | y = '' |
||
| ) |
Set multiple columns of the same size
| $numcols | (int) number of columns (set to zero to disable columns mode) |
| $width | (int) column width |
| $y | (int) column starting Y position (leave empty for current Y position) |
Definition at line 26033 of file tcpdf.php.
| setExtGState | ( | $ | gs | ) | [protected] |
| setExtraXMP | ( | $ | xmp | ) |
Set additional XMP data to be added on the default XMP data just before the end of "x:xmpmeta" tag. IMPORTANT: This data is added as-is without controls, so you have to validate your data before using this method!
| $xmp | (string) Custom XMP data. |
| SetFillColor | ( | $ | col1 = 0, |
| $ | col2 = -1, |
||
| $ | col3 = -1, |
||
| $ | col4 = -1, |
||
| $ | ret = false, |
||
| $ | name = '' |
||
| ) |
Defines the color used for all filling operations (filled rectangles and cell backgrounds). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
| $col1 | (float) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100). |
| $col2 | (float) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100). |
| $col3 | (float) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100). |
| $col4 | (float) KEY (BLACK) color for CMYK (0-100). |
| $ret | (boolean) If true do not send the command. |
| $name | (string) Spot color name (if any). |
Definition at line 4764 of file tcpdf.php.
| SetFillColorArray | ( | $ | color, |
| $ | ret = false |
||
| ) |
Defines the color used for all filling operations (filled rectangles and cell backgrounds). It can be expressed in RGB, CMYK or GRAY SCALE components. The method can be called before the first page is created and the value is retained from page to page.
| $color | (array) Array of colors (1, 3 or 4 values). |
| $ret | (boolean) If true do not send the PDF command. |
Definition at line 4627 of file tcpdf.php.
| SetFillSpotColor | ( | $ | name, |
| $ | tint = 100 |
||
| ) |
Defines the spot color used for all filling operations (filled rectangles and cell backgrounds).
| $name | (string) Name of the spot color. |
| $tint | (float) Intensity of the color (from 0 to 100 ; 100 = full intensity by default). |
Definition at line 4555 of file tcpdf.php.
Sets the font used to print character strings. The font can be either a standard one or a font added via the AddFont() method. Standard fonts use Windows encoding cp1252 (Western Europe). The method can be called before the first page is created and the font is retained from page to page. If you just wish to change the current font size, it is simpler to call SetFontSize(). Note: for the standard fonts, the font metric files must be accessible. There are three possibilities for this:
| $family | (string) Family font. It can be either a name defined by AddFont() or one of the standard Type1 families (case insensitive):
|
| $style | (string) Font style. Possible values are (case insensitive):
|
| $size | (float) Font size in points. The default value is the current size. If no size has been specified since the beginning of the document, the value taken is 12 |
| $fontfile | (string) The font definition file. By default, the name is built from the family and style, in lower case with no spaces. |
| $subset | (mixed) if true embedd only a subset of the font (stores only the information related to the used characters); if false embedd full font; if 'default' uses the default value set using setFontSubsetting(). This option is valid only for TrueTypeUnicode fonts. If you want to enable users to change the document, set this parameter to false. If you subset the font, the person who receives your PDF would need to have your same font in order to make changes to your PDF. The file size of the PDF would also be smaller because you are embedding only part of a font. |
| $out | (boolean) if true output the font size command, otherwise only set the font properties. |
Definition at line 5202 of file tcpdf.php.
| setFontBuffer | ( | $ | font, |
| $ | data | ||
| ) | [protected] |
| SetFontSize | ( | $ | size, |
| $ | out = true |
||
| ) |
Defines the size of the current font.
| $size | (float) The font size in points. |
| $out | (boolean) if true output the font size command, otherwise only set the font properties. |
Definition at line 5223 of file tcpdf.php.
| setFontSpacing | ( | $ | spacing = 0 | ) |
Set the amount to increase or decrease the space between characters in a text.
| $spacing | (float) amount to increase or decrease the space between characters in a text (0 = default spacing) |
Definition at line 26886 of file tcpdf.php.
| setFontStretching | ( | $ | perc = 100 | ) |
| setFontSubBuffer | ( | $ | font, |
| $ | key, | ||
| $ | data | ||
| ) | [protected] |
| setFontSubsetting | ( | $ | enable = true | ) |
| setFooter | ( | ) | [protected] |
| setFooterFont | ( | $ | font | ) |
| setFooterMargin | ( | $ | fm = 10 | ) |
| setFormDefaultProp | ( | $ | prop = array() | ) |
| setGraphicVars | ( | $ | gvars, |
| $ | extended = false |
||
| ) | [protected] |
Set graphic variables.
| $gvars | (array) array of graphic variablesto restore |
| $extended | (boolean) if true restore extended graphic variables |
Definition at line 24908 of file tcpdf.php.
| setHeader | ( | ) | [protected] |
| setHeaderData | ( | $ | ln = '', |
| $ | lw = 0, |
||
| $ | ht = '', |
||
| $ | hs = '' |
||
| ) |
| setHeaderFont | ( | $ | font | ) |
| setHeaderMargin | ( | $ | hm = 10 | ) |
| setHeaderTemplateAutoreset | ( | $ | val = true | ) |
| setHtmlLinksStyle | ( | $ | color = array(0,0,255), |
| $ | fontstyle = 'U' |
||
| ) |
| setHtmlVSpace | ( | $ | tagvs | ) |
Set the vertical spaces for HTML tags. The array must have the following structure (example): $tagvs = array('h1' => array(0 => array('h' => '', 'n' => 2), 1 => array('h' => 1.3, 'n' => 1))); The first array level contains the tag names, the second level contains 0 for opening tags or 1 for closing tags, the third level contains the vertical space unit (h) and the number spaces to add (n). If the h parameter is not specified, default values are used.
| $tagvs | (array) array of tags and relative vertical spaces. |
Definition at line 24459 of file tcpdf.php.
| setImageBuffer | ( | $ | image, |
| $ | data | ||
| ) | [protected] |
| setImageScale | ( | $ | scale | ) |
| setImageSubBuffer | ( | $ | image, |
| $ | key, | ||
| $ | data | ||
| ) | [protected] |
| setJPEGQuality | ( | $ | quality | ) |
| SetKeywords | ( | $ | keywords | ) |
Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
| $keywords | (string) The list of keywords. |
| setLanguageArray | ( | $ | language | ) |
| setLastH | ( | $ | h | ) |
| SetLeftMargin | ( | $ | margin | ) |
Defines the left margin. The method can be called before creating the first page. If the current abscissa gets out of page, it is brought back to the margin.
| $margin | (float) The margin. |
| SetLineStyle | ( | $ | style, |
| $ | ret = false |
||
| ) |
Set line style.
| $style | (array) Line style. Array with keys among the following:
|
| $ret | (boolean) if true do not send the command. |
Definition at line 14651 of file tcpdf.php.
| SetLineWidth | ( | $ | width | ) |
Defines the line width. By default, the value equals 0.2 mm. The method can be called before the first page is created and the value is retained from page to page.
| $width | (float) The width. |
Definition at line 14608 of file tcpdf.php.
| SetLink | ( | $ | link, |
| $ | y = 0, |
||
| $ | page = -1 |
||
| ) |
Defines the page and position a link points to.
| $link | (int) The link identifier returned by AddLink() |
| $y | (float) Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page) |
| $page | (int) Number of target page; -1 indicates the current page. This is the default value |
Definition at line 5332 of file tcpdf.php.
| setListIndentWidth | ( | $ | width | ) |
| setLIsymbol | ( | $ | symbol = '!' | ) |
Set the default bullet to be used as LI bullet symbol
| $symbol | (string) character or string to be used (legal values are: '' = automatic, '!' = auto bullet, '#' = auto numbering, 'disc', 'disc', 'circle', 'square', '1', 'decimal', 'decimal-leading-zero', 'i', 'lower-roman', 'I', 'upper-roman', 'a', 'lower-alpha', 'lower-latin', 'A', 'upper-alpha', 'upper-latin', 'lower-greek', 'img|type|width|height|image.ext') |
| SetMargins | ( | $ | left, |
| $ | top, | ||
| $ | right = -1, |
||
| $ | keepmargins = false |
||
| ) |
Defines the left, top and right margins.
| $left | (float) Left margin. |
| $top | (float) Top margin. |
| $right | (float) Right margin. Default value is the left one. |
| $keepmargins | (boolean) if true overwrites the default page margins |
Definition at line 3289 of file tcpdf.php.
| setOpenCell | ( | $ | isopen | ) |
| setPage | ( | $ | pnum, |
| $ | resetmargins = false |
||
| ) |
Move pointer at the specified document page and update page dimensions.
| $pnum | (int) page number (1 ... numpages) |
| $resetmargins | (boolean) if true reset left, right, top margins and Y position. |
Definition at line 3778 of file tcpdf.php.
| setPageBoxes | ( | $ | page, |
| $ | type, | ||
| $ | llx, | ||
| $ | lly, | ||
| $ | urx, | ||
| $ | ury, | ||
| $ | points = false |
||
| ) |
Set page boundaries.
| $page | (int) page number |
| $type | (string) valid values are:
|
| $llx | (float) lower-left x coordinate in user units |
| $lly | (float) lower-left y coordinate in user units |
| $urx | (float) upper-right x coordinate in user units |
| $ury | (float) upper-right y coordinate in user units |
| $points | (boolean) if true uses user units as unit of measure, otherwise uses PDF points |
Definition at line 2911 of file tcpdf.php.
| setPageBuffer | ( | $ | page, |
| $ | data, | ||
| $ | append = false |
||
| ) | [protected] |
| setPageFormat | ( | $ | format, |
| $ | orientation = 'P' |
||
| ) | [protected] |
Change the format of the current page
| $format | (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() documentation or an array of two numners (width, height) or an array containing the following measures and options:
|
| $orientation | (string) page orientation. Possible values are (case insensitive):
|
Definition at line 2793 of file tcpdf.php.
| setPageMark | ( | ) |
Set start-writing mark on current page stream used to put borders and fills. Borders and fills are always created after content and inserted on the position marked by this method. This function must be called after calling Image() function for a background image. Background images must be always inserted before calling Multicell() or WriteHTMLCell() or WriteHTML() functions.
Definition at line 4006 of file tcpdf.php.
| setPageOrientation | ( | $ | orientation, |
| $ | autopagebreak = '', |
||
| $ | bottommargin = '' |
||
| ) |
Set page orientation.
| $orientation | (string) page orientation. Possible values are (case insensitive):
|
| $autopagebreak | (boolean) Boolean indicating if auto-page-break mode should be on or off. |
| $bottommargin | (float) bottom margin of the page. |
Definition at line 2960 of file tcpdf.php.
| setPageRegions | ( | $ | regions = array() | ) |
Set no-write regions on page. A no-write region is a portion of the page with a rectangular or trapezium shape that will not be covered when writing text or html code. A region is always aligned on the left or right side of the page ad is defined using a vertical segment. You can set multiple regions for the same page.
| $regions | (array) array of no-write regions. For each region you can define an array as follow: ('page' => page number or empy for current page, 'xt' => X top, 'yt' => Y top, 'xb' => X bottom, 'yb' => Y bottom, 'side' => page side 'L' = left or 'R' = right). Omit this parameter to remove all regions. |
Definition at line 26924 of file tcpdf.php.
| setPageUnit | ( | $ | unit | ) |
Set the units of measure for the document.
| $unit | (string) User measure unit. Possible values are:
A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit. |
Definition at line 2033 of file tcpdf.php.
| setPDFVersion | ( | $ | version = '1.7' | ) |
| setPrintFooter | ( | $ | val = true | ) |
| setPrintHeader | ( | $ | val = true | ) |
| SetProtection | ( | $ | permissions = array('print', 'modify', 'copy', 'annot-forms', 'fill-forms', 'extract', 'assemble', 'print-high'), |
| $ | user_pass = '', |
||
| $ | owner_pass = null, |
||
| $ | mode = 0, |
||
| $ | pubkeys = null |
||
| ) |
Set document protection Remark: the protection against modification is for people who have the full Acrobat product. If you don't set any password, the document will open as usual. If you set a user password, the PDF viewer will ask for it before displaying the document. The master password, if different from the user one, can be used to get full access. Note: protecting a document requires to encrypt it, which increases the processing time a lot. This can cause a PHP time-out in some cases, especially if the document contains images or fonts.
| $permissions | (Array) the set of permissions (specify the ones you want to block):
|
| $user_pass | (String) user password. Empty by default. |
| $owner_pass | (String) owner password. If not specified, a random value is used. |
| $mode | (int) encryption strength: 0 = RC4 40 bit; 1 = RC4 128 bit; 2 = AES 128 bit; 3 = AES 256 bit. |
| $pubkeys | (String) array of recipients containing public-key certificates ('c') and permissions ('p'). For example: array(array('c' => 'file://../tcpdf.crt', 'p' => array('print'))) |
Definition at line 14124 of file tcpdf.php.
| setRasterizeVectorImages | ( | $ | mode | ) |
| SetRightMargin | ( | $ | margin | ) |
Defines the right margin. The method can be called before creating the first page.
| $margin | (float) The margin. |
| setSignature | ( | $ | signing_cert = '', |
| $ | private_key = '', |
||
| $ | private_key_password = '', |
||
| $ | extracerts = '', |
||
| $ | cert_type = 2, |
||
| $ | info = array() |
||
| ) |
Enable document signature (requires the OpenSSL Library). The digital signature improve document authenticity and integrity and allows o enable extra features on Acrobat Reader. To create self-signed signature: openssl req -x509 -nodes -days 365000 -newkey rsa:1024 -keyout tcpdf.crt -out tcpdf.crt To export crt to p12: openssl pkcs12 -export -in tcpdf.crt -out tcpdf.p12 To convert pfx certificate to pem: openssl pkcs12 -in tcpdf.pfx -out tcpdf.crt -nodes
| $signing_cert | (mixed) signing certificate (string or filename prefixed with 'file://') |
| $private_key | (mixed) private key (string or filename prefixed with 'file://') |
| $private_key_password | (string) password |
| $extracerts | (string) specifies the name of a file containing a bunch of extra certificates to include in the signature which can for example be used to help the recipient to verify the certificate that you used. |
| $cert_type | (int) The access permissions granted for this document. Valid values shall be: 1 = No changes to the document shall be permitted; any change to the document shall invalidate the signature; 2 = Permitted changes shall be filling in forms, instantiating page templates, and signing; other changes shall invalidate the signature; 3 = Permitted changes shall be the same as for 2, as well as annotation creation, deletion, and modification; other changes shall invalidate the signature. |
| $info | (array) array of option information: Name, Location, Reason, ContactInfo. |
| setSignatureAppearance | ( | $ | x = 0, |
| $ | y = 0, |
||
| $ | w = 0, |
||
| $ | h = 0, |
||
| $ | page = -1 |
||
| ) |
Set the digital signature appearance (a cliccable rectangle area to get signature properties)
| $x | (float) Abscissa of the upper-left corner. |
| $y | (float) Ordinate of the upper-left corner. |
| $w | (float) Width of the signature area. |
| $h | (float) Height of the signature area. |
| $page | (int) option page number (if < 0 the current page is used). |
Definition at line 17624 of file tcpdf.php.
| setSpacesRE | ( | $ | re = '/[^\S\xa0]/' | ) |
Set regular expression to detect withespaces or word separators. The pattern delimiter must be the forward-slash character "/". Some example patterns are:
Non-Unicode or missing PCRE unicode support: "/[^\S\xa0]/"
Unicode and PCRE unicode support: "/[^\S\P{Z}\xa0]/u"
Unicode and PCRE unicode support in Chinese mode: "/[^\S\P{Z}\P{Lo}\xa0]/u"
if PCRE unicode support is turned ON ("\P" is the negate class of "\p"):
"\p{Z}" or "\p{Separator}": any kind of Unicode whitespace or invisible separator.
"\p{Lo}" or "\p{Other_Letter}": a Unicode letter or ideograph that does not have lowercase and uppercase variants.
"\p{Lo}" is needed for Chinese characters because are packed next to each other without spaces in between.
| $re | (string) regular expression (leave empty for default). |
Definition at line 3065 of file tcpdf.php.
| setSpotColor | ( | $ | type, |
| $ | name, | ||
| $ | tint = 100 |
||
| ) |
Set the spot color for the specified type ('draw', 'fill', 'text').
| $type | (string) Type of object affected by this color: ('draw', 'fill', 'text'). |
| $name | (string) Name of the spot color. |
| $tint | (float) Intensity of the color (from 0 to 100 ; 100 = full intensity by default). |
Definition at line 4496 of file tcpdf.php.
| setSRGBmode | ( | $ | mode = false | ) |
| setStartingPageNumber | ( | $ | num = 1 | ) |
| SetSubject | ( | $ | subject | ) |
Defines the subject of the document.
| $subject | (string) The 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 ***)
| $svgstyle | (array) array of SVG styles to apply |
| $prevsvgstyle | (array) array of previous SVG style |
| $x | (int) X origin of the bounding box |
| $y | (int) Y origin of the bounding box |
| $w | (int) width of the bounding box |
| $h | (int) height of the bounding box |
| $clip_function | (string) clip function |
| $clip_params | (array) array of parameters for clipping function |
Definition at line 27539 of file tcpdf.php.
| setTableHeader | ( | ) | [protected] |
| setTempRTL | ( | $ | mode | ) |
| SetTextColor | ( | $ | col1 = 0, |
| $ | col2 = -1, |
||
| $ | col3 = -1, |
||
| $ | col4 = -1, |
||
| $ | ret = false, |
||
| $ | name = '' |
||
| ) |
Defines the color used for text. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
| $col1 | (float) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100). |
| $col2 | (float) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100). |
| $col3 | (float) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100). |
| $col4 | (float) KEY (BLACK) color for CMYK (0-100). |
| $ret | (boolean) If true do not send the command. |
| $name | (string) Spot color name (if any). |
Definition at line 4781 of file tcpdf.php.
| SetTextColorArray | ( | $ | color, |
| $ | ret = false |
||
| ) |
Defines the color used for text. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
| $color | (array) Array of colors (1, 3 or 4 values). |
| $ret | (boolean) If true do not send the PDF command. |
Definition at line 4640 of file tcpdf.php.
| setTextRenderingMode | ( | $ | stroke = 0, |
| $ | fill = true, |
||
| $ | clip = false |
||
| ) |
Set Text rendering mode.
| $stroke | (int) outline size in user units (0 = disable). |
| $fill | (boolean) if true fills the text (default). |
| $clip | (boolean) if true activate clipping mode |
Definition at line 26204 of file tcpdf.php.
| SetTextSpotColor | ( | $ | name, |
| $ | tint = 100 |
||
| ) |
Defines the spot color used for text.
| $name | (string) Name of the spot color. |
| $tint | (int) Intensity of the color (from 0 to 100 ; 100 = full intensity by default). |
Definition at line 4567 of file tcpdf.php.
| SetTitle | ( | $ | title | ) |
Defines the title of the document.
| $title | (string) The title. |
| SetTopMargin | ( | $ | margin | ) |
Defines the top margin. The method can be called before creating the first page.
| $margin | (float) The margin. |
| setUserRights | ( | $ | enable = true, |
| $ | document = '/FullSave', |
||
| $ | annots = '/Create/Delete/Modify/Copy/Import/Export', |
||
| $ | form = '/Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate', |
||
| $ | signature = '/Modify', |
||
| $ | ef = '/Create/Delete/Modify/Import', |
||
| $ | formex = '' |
||
| ) |
Set User's Rights for PDF Reader WARNING: This is experimental and currently do not work. Check the PDF Reference 8.7.1 Transform Methods, Table 8.105 Entries in the UR transform parameters dictionary
| $enable | (boolean) if true enable user's rights on PDF reader |
| $document | (string) Names specifying additional document-wide usage rights for the document. The only defined value is "/FullSave", which permits a user to save the document along with modified form and/or annotation data. |
| $annots | (string) Names specifying additional annotation-related usage rights for the document. Valid names in PDF 1.5 and later are /Create/Delete/Modify/Copy/Import/Export, which permit the user to perform the named operation on annotations. |
| $form | (string) Names specifying additional form-field-related usage rights for the document. Valid names are: /Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate |
| $signature | (string) Names specifying additional signature-related usage rights for the document. The only defined value is /Modify, which permits a user to apply a digital signature to an existing signature form field or clear a signed signature form field. |
| $ef | (string) Names specifying additional usage rights for named embedded files in the document. Valid names are /Create/Delete/Modify/Import, which permit the user to perform the named operation on named embedded files Names specifying additional embedded-files-related usage rights for the document. |
| $formex | (string) Names specifying additional form-field-related usage rights. The only valid name is BarcodePlaintext, which permits text form field data to be encoded as a plaintext two-dimensional barcode. |
| setViewerPreferences | ( | $ | preferences | ) |
Set the viewer preferences dictionary controlling the way the document is to be presented on the screen or in print. (see Section 8.1 of PDF reference, "Viewer Preferences").
| $preferences | (array) array of options. |
| setVisibility | ( | $ | v | ) |
Set the visibility of the successive elements. This can be useful, for instance, to put a background image or color that will show on screen but won't print.
| $v | (string) visibility mode. Legal values are: all, print, screen or view. |
Definition at line 17909 of file tcpdf.php.
| SetX | ( | $ | x, |
| $ | rtloff = false |
||
| ) |
Defines the abscissa of the current position. If the passed value is negative, it is relative to the right of the page (or left if language is RTL).
| $x | (float) The value of the abscissa. |
| $rtloff | (boolean) if true always uses the page top-left corner as origin of axis. |
Definition at line 8362 of file tcpdf.php.
| SetXY | ( | $ | x, |
| $ | y, | ||
| $ | rtloff = false |
||
| ) |
Defines the abscissa and ordinate of the current position. If the passed values are negative, they are relative respectively to the right and bottom of the page.
| $x | (float) The value of the abscissa. |
| $y | (float) The value of the ordinate. |
| $rtloff | (boolean) if true always uses the page top-left corner as origin of axis. |
Definition at line 8426 of file tcpdf.php.
Moves the current abscissa back to the left margin and sets the ordinate. If the passed value is negative, it is relative to the bottom of the page.
| $y | (float) The value of the ordinate. |
| $resetx | (bool) if true (default) reset the X position. |
| $rtloff | (boolean) if true always uses the page top-left corner as origin of axis. |
Definition at line 8394 of file tcpdf.php.
| Skew | ( | $ | angle_x, |
| $ | angle_y, | ||
| $ | x = '', |
||
| $ | y = '' |
||
| ) |
Skew.
| $angle_x | (float) angle in degrees between -90 (skew to the left) and 90 (skew to the right) |
| $angle_y | (float) angle in degrees between -90 (skew to the bottom) and 90 (skew to the top) |
| $x | (int) abscissa of the skewing center. default is current x position |
| $y | (int) ordinate of the skewing center. default is current y position |
Definition at line 14548 of file tcpdf.php.
| SkewX | ( | $ | angle_x, |
| $ | x = '', |
||
| $ | y = '' |
||
| ) |
Skew horizontally.
| $angle_x | (float) angle in degrees between -90 (skew to the left) and 90 (skew to the right) |
| $x | (int) abscissa of the skewing center. default is current x position |
| $y | (int) ordinate of the skewing center. default is current y position |
Definition at line 14521 of file tcpdf.php.
| SkewY | ( | $ | angle_y, |
| $ | x = '', |
||
| $ | y = '' |
||
| ) |
Skew vertically.
| $angle_y | (float) angle in degrees between -90 (skew to the bottom) and 90 (skew to the top) |
| $x | (int) abscissa of the skewing center. default is current x position |
| $y | (int) ordinate of the skewing center. default is current y position |
Definition at line 14534 of file tcpdf.php.
| sortBookmarks | ( | ) | [protected] |
| StarPolygon | ( | $ | x0, |
| $ | y0, | ||
| $ | r, | ||
| $ | nv, | ||
| $ | ng, | ||
| $ | angle = 0, |
||
| $ | draw_circle = false, |
||
| $ | style = '', |
||
| $ | line_style = array(), |
||
| $ | fill_color = array(), |
||
| $ | circle_style = '', |
||
| $ | circle_outLine_style = array(), |
||
| $ | circle_fill_color = array() |
||
| ) |
Draws a star polygon
| $x0 | (float) Abscissa of center point. |
| $y0 | (float) Ordinate of center point. |
| $r | (float) Radius of inscribed circle. |
| $nv | (integer) Number of vertices. |
| $ng | (integer) Number of gap (if ($ng % $nv = 1) then is a regular polygon). |
| $angle,: | (float) Angle oriented (anti-clockwise). Default value: 0. |
| $draw_circle,: | (boolean) Draw inscribed circle or not. Default value is false. |
| $style | (string) Style of rendering. See the getPathPaintOperator() function for more information. |
| $line_style | (array) Line style of polygon sides. Array with keys among the following:
|
| $fill_color | (array) Fill color. Format: array(red, green, blue). Default value: default color (empty array). |
| $circle_style | (string) Style of rendering of inscribed circle (if draws). Possible values are:
|
| $circle_outLine_style | (array) Line style of inscribed circle (if draws). Array like for SetLineStyle(). Default value: default line style (empty array). |
| $circle_fill_color | (array) Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array). |
Definition at line 15294 of file tcpdf.php.
| startLayer | ( | $ | name = '', |
| $ | print = true, |
||
| $ | view = true |
||
| ) |
Start a new pdf layer.
| $name | (string) Layer name (only a-z letters and numbers). Leave empty for automatic name. |
| (boolean) Set to true to print this layer. | |
| $view | (boolean) Set to true to view this layer. |
Definition at line 17876 of file tcpdf.php.
| startPage | ( | $ | orientation = '', |
| $ | format = '', |
||
| $ | tocpage = false |
||
| ) |
Starts a new page to the document. The page must be closed using the endPage() function. The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards.
| $orientation | (string) page orientation. Possible values are (case insensitive):
|
| $format | (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat(). |
| $tocpage | (boolean) if true the page is designated to contain the Table-Of-Content. |
Definition at line 3935 of file tcpdf.php.
| startPageGroup | ( | $ | page = '' | ) |
| startSVGElementHandler | ( | $ | parser, |
| $ | name, | ||
| $ | attribs, | ||
| $ | ctm = array() |
||
| ) | [protected] |
Sets the opening SVG element handler function for the XML parser. (*** TO BE COMPLETED ***)
| $parser | (resource) The first parameter, parser, is a reference to the XML parser calling the handler. |
| $name | (string) The second parameter, name, contains the name of the element for which this handler is called. If case-folding is in effect for this parser, the element name will be in uppercase letters. |
| $attribs | (array) The third parameter, attribs, contains an associative array with the element's attributes (if any). The keys of this array are the attribute names, the values are the attribute values. Attribute names are case-folded on the same criteria as element names. Attribute values are not case-folded. The original order of the attributes can be retrieved by walking through attribs the normal way, using each(). The first key in the array was the first attribute, and so on. |
| $ctm | (array) tranformation matrix for clipping mode (starting transformation matrix). |
Definition at line 28195 of file tcpdf.php.
| startTemplate | ( | $ | w = 0, |
| $ | h = 0, |
||
| $ | group = false |
||
| ) |
Start a new XObject Template. An XObject Template is a PDF block that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images). An XObject Template may be painted multiple times, either on several pages or at several locations on the same page and produces the same results each time, subject only to the graphics state at the time it is invoked. Note: X,Y coordinates will be reset to 0,0.
| $w | (int) Template width in user units (empty string or zero = page width less margins). |
| $h | (int) Template height in user units (empty string or zero = page height less margins). |
| $group | (mixed) Set transparency group. Can be a boolean value or an array specifying optional parameters: 'CS' (solour space name), 'I' (boolean flag to indicate isolated group) and 'K' (boolean flag to indicate knockout group). |
Definition at line 26646 of file tcpdf.php.
| startTransaction | ( | ) |
| StartTransform | ( | ) |
Starts a 2D tranformation saving current graphic state. This function must be called before scaling, mirroring, translation, rotation and skewing. Use StartTransform() before, and StopTransform() after the transformations to restore the normal behavior.
Definition at line 14283 of file tcpdf.php.
| StopTransform | ( | ) |
Stops a 2D tranformation restoring previous graphic state. This function must be called after scaling, mirroring, translation, rotation and skewing. Use StartTransform() before, and StopTransform() after the transformations to restore the normal behavior.
Definition at line 14303 of file tcpdf.php.
| stringLeftTrim | ( | $ | str, |
| $ | replace = '' |
||
| ) |
| stringRightTrim | ( | $ | str, |
| $ | replace = '' |
||
| ) |
| stringTrim | ( | $ | str, |
| $ | replace = '' |
||
| ) |
| SVGPath | ( | $ | d, |
| $ | style = '' |
||
| ) | [protected] |
Draws an SVG path
| $d | (string) attribute d of the path SVG element |
| $style | (string) Style of rendering. Possible values are:
|
Definition at line 27820 of file tcpdf.php.
| SVGTransform | ( | $ | tm | ) | [protected] |
| swapMargins | ( | $ | reverse = true | ) | [protected] |
| swapPageBoxCoordinates | ( | $ | page | ) | [protected] |
| Text | ( | $ | x, |
| $ | y, | ||
| $ | txt, | ||
| $ | fstroke = false, |
||
| $ | fclip = false, |
||
| $ | ffill = true, |
||
| $ | border = 0, |
||
| $ | ln = 0, |
||
| $ | align = '', |
||
| $ | fill = false, |
||
| $ | link = '', |
||
| $ | stretch = 0, |
||
| $ | ignore_min_height = false, |
||
| $ | calign = 'T', |
||
| $ | valign = 'M', |
||
| $ | rtloff = false |
||
| ) |
Prints a text cell at the specified position. This method allows to place a string precisely on the page.
| $x | (float) Abscissa of the cell origin |
| $y | (float) Ordinate of the cell origin |
| $txt | (string) String to print |
| $fstroke | (int) outline size in user units (false = disable) |
| $fclip | (boolean) if true activate clipping mode (you must call StartTransform() before this function and StopTransform() to stop the clipping tranformation). |
| $ffill | (boolean) if true fills the text |
| $border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
| $ln | (int) Indicates where the current position should go after the call. Possible values are:
|
| $align | (string) Allows to center or align the text. Possible values are:
|
| $fill | (boolean) Indicates if the cell background must be painted (true) or transparent (false). |
| $link | (mixed) URL or identifier returned by AddLink(). |
| $stretch | (int) font stretch mode:
|
| $ignore_min_height | (boolean) if true ignore automatic minimum height value. |
| $calign | (string) cell vertical alignment relative to the specified Y value. Possible values are:
|
| $valign | (string) text vertical alignment inside the cell. Possible values are:
|
| $rtloff | (boolean) if true uses the page top-left corner as origin of axis for $x and $y initial position. |
Definition at line 5507 of file tcpdf.php.
Creates a text field
| $name | (string) field name |
| $w | (float) Width of the rectangle |
| $h | (float) Height of the rectangle |
| $prop | (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference. |
| $opt | (array) annotation parameters. Possible values are described on official PDF32000_2008 reference. |
| $x | (float) Abscissa of the upper-left corner of the rectangle |
| $y | (float) Ordinate of the upper-left corner of the rectangle |
| $js | (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered). |
Definition at line 16871 of file tcpdf.php.
| Transform | ( | $ | tm | ) | [protected] |
Apply graphic transformations.
| $tm | (array) transformation matrix |
Definition at line 14579 of file tcpdf.php.
| Translate | ( | $ | t_x, |
| $ | t_y | ||
| ) |
Translate graphic object horizontally and vertically.
| $t_x | (int) movement to the right |
| $t_y | (int) movement to the bottom |
Definition at line 14469 of file tcpdf.php.
| TranslateX | ( | $ | t_x | ) |
Translate graphic object horizontally.
| $t_x | (int) movement to the right (or left for RTL) |
Definition at line 14446 of file tcpdf.php.
| TranslateY | ( | $ | t_y | ) |
Translate graphic object vertically.
| $t_y | (int) movement to the bottom |
Definition at line 14457 of file tcpdf.php.
| unhtmlentities | ( | $ | text_to_convert | ) |
| UniArrSubString | ( | $ | uniarr, |
| $ | start = '', |
||
| $ | end = '' |
||
| ) |
Extract a slice of the $uniarr array and return it as string.
| $uniarr | (string) The input array of characters. |
| $start | (int) the starting element of $strarr. |
| $end | (int) first element that will not be returned. |
Definition at line 7281 of file tcpdf.php.
| unichr | ( | $ | c | ) |
| updateCIDtoGIDmap | ( | $ | map, |
| $ | cid, | ||
| $ | gid | ||
| ) | [protected] |
| UTF8ArrayToUniArray | ( | $ | ta | ) |
| UTF8ArrSubString | ( | $ | strarr, |
| $ | start = '', |
||
| $ | end = '' |
||
| ) |
Extract a slice of the $strarr array and return it as string.
| $strarr | (string) The input array of characters. |
| $start | (int) the starting element of $strarr. |
| $end | (int) first element that will not be returned. |
Definition at line 7258 of file tcpdf.php.
| UTF8ArrToLatin1 | ( | $ | unicode | ) | [protected] |
| utf8Bidi | ( | $ | ta, |
| $ | str = '', |
||
| $ | forcertl = false |
||
| ) | [protected] |
Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
| $ta | (array) array of characters composing the string. |
| $str | (string) string to process |
| $forcertl | (bool) if 'R' forces RTL, if 'L' forces LTR |
Definition at line 15516 of file tcpdf.php.
| utf8StrArrRev | ( | $ | arr, |
| $ | str = '', |
||
| $ | setbom = false, |
||
| $ | forcertl = false |
||
| ) | [protected] |
Reverse the RLT substrings array using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
| $arr | (array) array of unicode values. |
| $str | (string) string to manipulate (or empty value). |
| $setbom | (bool) if true set the Byte Order Mark (BOM = 0xFEFF) |
| $forcertl | (bool) if true forces RTL text direction |
Definition at line 15502 of file tcpdf.php.
| UTF8StringToArray | ( | $ | str | ) | [protected] |
Converts UTF-8 strings to codepoints array.
Invalid byte sequences will be replaced with 0xFFFD (replacement character)
Based on: http://www.faqs.org/rfcs/rfc3629.html
Char. number range | UTF-8 octet sequence
(hexadecimal) | (binary)
--------------------+-----------------------------------------------
0000 0000-0000 007F | 0xxxxxxx
0000 0080-0000 07FF | 110xxxxx 10xxxxxx
0000 0800-0000 FFFF | 1110xxxx 10xxxxxx 10xxxxxx
0001 0000-0010 FFFF | 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
---------------------------------------------------------------------ABFN notation: --------------------------------------------------------------------- UTF8-octets = *( UTF8-char ) UTF8-char = UTF8-1 / UTF8-2 / UTF8-3 / UTF8-4 UTF8-1 = x00-7F UTF8-2 = xC2-DF UTF8-tail
UTF8-3 = xE0 xA0-BF UTF8-tail / xE1-EC 2( UTF8-tail ) /
xED x80-9F UTF8-tail / xEE-EF 2( UTF8-tail )
UTF8-4 = xF0 x90-BF 2( UTF8-tail ) / xF1-F3 3( UTF8-tail ) /
xF4 x80-8F 2( UTF8-tail )
UTF8-tail = x80-BF
---------------------------------------------------------------------
| $str | (string) string to process. |
Definition at line 13056 of file tcpdf.php.
| utf8StrRev | ( | $ | str, |
| $ | setbom = false, |
||
| $ | forcertl = false |
||
| ) | [protected] |
Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
| $str | (string) string to manipulate. |
| $setbom | (bool) if true set the Byte Order Mark (BOM = 0xFEFF) |
| $forcertl | (bool) if true forces RTL text direction |
Definition at line 15487 of file tcpdf.php.
| UTF8ToLatin1 | ( | $ | str | ) | [protected] |
| UTF8ToUTF16BE | ( | $ | str, |
| $ | setbom = false |
||
| ) | [protected] |
Converts UTF-8 strings to UTF16-BE.
| $str | (string) string to process. |
| $setbom | (boolean) if true set the Byte Order Mark (BOM = 0xFEFF) |
Definition at line 13175 of file tcpdf.php.
| Write | ( | $ | h, |
| $ | txt, | ||
| $ | link = '', |
||
| $ | fill = false, |
||
| $ | align = '', |
||
| $ | ln = false, |
||
| $ | stretch = 0, |
||
| $ | firstline = false, |
||
| $ | firstblock = false, |
||
| $ | maxh = 0, |
||
| $ | wadj = 0, |
||
| $ | margin = '' |
||
| ) |
This method prints text from the current position.
| $h | (float) Line height |
| $txt | (string) String to print |
| $link | (mixed) URL or identifier returned by AddLink() |
| $fill | (boolean) Indicates if the cell background must be painted (true) or transparent (false). |
| $align | (string) Allows to center or align the text. Possible values are:
|
| $ln | (boolean) if true set cursor at the bottom of the line, otherwise set cursor at the top of the line. |
| $stretch | (int) font stretch mode:
|
| $firstline | (boolean) if true prints only the first line and return the remaining string. |
| $firstblock | (boolean) if true the string is the starting of a line. |
| $maxh | (float) maximum height. The remaining unprinted text will be returned. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature. |
| $wadj | (float) first line width will be reduced by this amount (used in HTML mode). |
| $margin | (array) margin array of the parent container |
Definition at line 6835 of file tcpdf.php.
| write1DBarcode | ( | $ | code, |
| $ | type, | ||
| $ | x = '', |
||
| $ | y = '', |
||
| $ | w = '', |
||
| $ | h = '', |
||
| $ | xres = '', |
||
| $ | style = '', |
||
| $ | align = '' |
||
| ) |
Print a Linear Barcode.
| $code | (string) code to print |
| $type | (string) type of barcode (see barcodes.php for supported formats). |
| $x | (int) x position in user units (empty string = current x position) |
| $y | (int) y position in user units (empty string = current y position) |
| $w | (int) width in user units (empty string = remaining page width) |
| $h | (int) height in user units (empty string = remaining page height) |
| $xres | (float) width of the smallest bar in user units (empty string = default value = 0.4mm) |
| $style | (array) array of options:
|
| $align | (string) Indicates the alignment of the pointer next to barcode insertion relative to barcode height. The value can be:
|
Definition at line 19177 of file tcpdf.php.
| write2DBarcode | ( | $ | code, |
| $ | type, | ||
| $ | x = '', |
||
| $ | y = '', |
||
| $ | w = '', |
||
| $ | h = '', |
||
| $ | style = '', |
||
| $ | align = '', |
||
| $ | distort = false |
||
| ) |
Print 2D Barcode.
| $code | (string) code to print |
| $type | (string) type of barcode (see 2dbarcodes.php for supported formats). |
| $x | (int) x position in user units |
| $y | (int) y position in user units |
| $w | (int) width in user units |
| $h | (int) height in user units |
| $style | (array) array of options:
|
| $align | (string) Indicates the alignment of the pointer next to barcode insertion relative to barcode height. The value can be:
|
| $distort | (boolean) if true distort the barcode to fit width and height, otherwise preserve aspect ratio |
Definition at line 19548 of file tcpdf.php.
| writeBarcode | ( | $ | x, |
| $ | y, | ||
| $ | w, | ||
| $ | h, | ||
| $ | type, | ||
| $ | style, | ||
| $ | font, | ||
| $ | xres, | ||
| $ | code | ||
| ) |
This function is DEPRECATED, please use the new write1DBarcode() function.
| $x | (int) x position in user units |
| $y | (int) y position in user units |
| $w | (int) width in user units |
| $h | (int) height position in user units |
| $type | (string) type of barcode |
| $style | (string) barcode style |
| $font | (string) font for text |
| $xres | (int) x resolution |
| $code | (string) code to print |
Definition at line 19483 of file tcpdf.php.
| writeDiskCache | ( | $ | filename, |
| $ | data, | ||
| $ | append = false |
||
| ) | [protected] |
Writes data to a temporary file on filesystem.
| $filename | (string) file name |
| $data | (mixed) data to write on file |
| $append | (boolean) if true append data, false replace. |
Definition at line 24983 of file tcpdf.php.
Allows to preserve some HTML formatting (limited support).
IMPORTANT: The HTML must be well formatted - try to clean-up it using an application like HTML-Tidy before submitting. Supported tags are: a, b, blockquote, br, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, img, li, ol, p, pre, small, span, strong, sub, sup, table, tcpdf, td, th, thead, tr, tt, u, ul
| $html | (string) text to display |
| $ln | (boolean) if true add a new line after text (default = true) |
| $fill | (boolean) Indicates if the background must be painted (true) or transparent (false). |
| $reseth | (boolean) if true reset the last cell height (default false). |
| $cell | (boolean) if true add the current left (or right for RTL) padding to each Write (default false). |
| $align | (string) Allows to center or align the text. Possible values are:
|
Definition at line 21427 of file tcpdf.php.
| writeHTMLCell | ( | $ | w, |
| $ | h, | ||
| $ | x, | ||
| $ | y, | ||
| $ | html = '', |
||
| $ | border = 0, |
||
| $ | ln = 0, |
||
| $ | fill = false, |
||
| $ | reseth = true, |
||
| $ | align = '', |
||
| $ | autopadding = true |
||
| ) |
Prints a cell (rectangular area) with optional borders, background color and html text string. The upper-left corner of the cell corresponds to the current position. After the call, the current position moves to the right or to the next line.
If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
| $w | (float) Cell width. If 0, the cell extends up to the right margin. |
| $h | (float) Cell minimum height. The cell extends automatically if needed. |
| $x | (float) upper-left corner X coordinate |
| $y | (float) upper-left corner Y coordinate |
| $html | (string) html text to print. Default value: empty string. |
| $border | (mixed) Indicates if borders must be drawn around the cell. The value can be a number:
|
| $ln | (int) Indicates where the current position should go after the call. Possible values are:
|
| $fill | (boolean) Indicates if the cell background must be painted (true) or transparent (false). |
| $reseth | (boolean) if true reset the last cell height (default true). |
| $align | (string) Allows to center or align the text. Possible values are:
|
| $autopadding | (boolean) if true, uses internal padding and automatically adjust it to account for line width. |
Definition at line 21411 of file tcpdf.php.
$alias_group_num_page = '{:png:}' [protected] |
$alias_group_tot_pages = '{:ptg:}' [protected] |
$alias_num_page = '{:pnp:}' [protected] |
$alias_right_shift = '{rsc:' [protected] |
$alias_tot_pages = '{:ptp:}' [protected] |
$annotation_fonts = array() [protected] |
$barcode = false [protected] |
$booklet = false [protected] |
$bordermrk = array() [protected] |
$bufferlen = 0 [protected] |
$byterange_string = '/ByteRange[0 ********** ********** **********]' [protected] |
$cache_file_length = array() [protected] |
$cache_maxsize_UTF8StringToArray = 8 [protected] |
Maximum size of cache array used for UTF8StringToArray() method.
$cache_size_UTF8StringToArray = 0 [protected] |
Current size of cache array used for UTF8StringToArray() method.
$cache_UTF8StringToArray = array() [protected] |
Cache array for UTF8StringToArray() method.
$cell_height_ratio = K_CELL_HEIGHT_RATIO [protected] |
$cell_margin = array('T' => 0, 'R' => 0, 'B' => 0, 'L' => 0) [protected] |
$cell_padding = array('T' => 0, 'R' => 0, 'B' => 0, 'L' => 0) [protected] |
$cntmrk = array() [protected] |
$ColorFlag [protected] |
$column_start_page = 0 [protected] |
$columns = array() [protected] |
$CurOrientation [protected] |
$current_column = 0 [protected] |
$currpagegroup = 0 [protected] |
$custom_xmp = '' [protected] |
$customlistindent = -1 [protected] |
$default_graphic_vars = array() [protected] |
$default_monospaced_font = 'courier' [protected] |
$default_table_columns = 4 [protected] |
$dests = array() [protected] |
$diffs = array() [protected] |
$diskcache = false [protected] |
$doc_date [protected] |
$docinfounicode = true [protected] |
$dpi = 72 [protected] |
$embeddedfiles = array() [protected] |
$empty_signature_appearance = array() [protected] |
$emptypagemrk = array() [protected] |
$enc_padding = "\x28\xBF\x4E\x5E\x4E\x75\x8A\x41\x64\x00\x4E\x56\xFF\xFA\x01\x08\x2E\x2E\x00\xB6\xD0\x68\x3E\x80\x2F\x0C\xA9\xFE\x64\x53\x69\x7A" [protected] |
$encmaps [protected] |
$encoding = 'UTF-8' [protected] |
$encryptdata = array() [protected] |
$encrypted [protected] |
$endlinex = 0 [protected] |
$epsmarker = 'x#!#EPS#!#x' [protected] |
$extgstates [protected] |
$feps = 0.005 [protected] |
$file_id [protected] |
$font_obj_ids = array() [protected] |
$font_spacing = 0 [protected] |
$font_stretching = 100 [protected] |
$font_subsetting = true [protected] |
$FontAscent [protected] |
$FontDescent [protected] |
$fontkeys = array() [protected] |
$fontlist = array() [protected] |
$footer_font [protected] |
$footer_margin [protected] |
$footerlen = array() [protected] |
$footerpos = array() [protected] |
$force_srgb = false [protected] |
$form_action = '' [protected] |
$form_enctype = 'application/x-www-form-urlencoded' [protected] |
$form_mode = 'post' [protected] |
$form_obj_id = array() [protected] |
$gradients = array() [protected] |
$header_font [protected] |
$header_logo_width = 30 [protected] |
$header_margin [protected] |
$header_string = '' [protected] |
$header_title = '' [protected] |
$header_xobj_autoreset = false [protected] |
$header_xobjid = -1 [protected] |
$HREF = array() [protected] |
$htmlLinkColorArray = array(0, 0, 255) [protected] |
$htmlLinkFontStyle = 'U' [protected] |
$htmlvspace = 0 [protected] |
$imagekeys = array() [protected] |
$img_rb_x [protected] |
$img_rb_y [protected] |
$imgscale = 1 [protected] |
$InFooter = false [protected] |
$InHeader = false [protected] |
$internal_encoding [protected] |
$inthead = false [protected] |
$intmrk = array() [protected] |
$inxobj = false [protected] |
$isunicode = false [protected] |
$javascript = '' [protected] |
$jpeg_quality [protected] |
$js_objects = array() [protected] |
$k [protected] |
$last_enc_key [protected] |
$last_enc_key_c [protected] |
$linestyleCap = '0 J' [protected] |
$linestyleDash = '[] 0 d' [protected] |
$linestyleJoin = '0 j' [protected] |
$linestyleWidth = '' [protected] |
$linethrough [protected] |
$listcount = array() [protected] |
$listindent = 0 [protected] |
$listindentlevel = 0 [protected] |
$listnum = 0 [protected] |
$listordered = array() [protected] |
$lisymbol = '' [protected] |
$n_dests [protected] |
$n_js [protected] |
$newline = true [protected] |
$newpagegroup = array() [protected] |
$num_columns = 1 [protected] |
$numfonts = 0 [protected] |
$numimages = 0 [protected] |
$numpages = 0 [protected] |
$objcopy [protected] |
$opencell = true [protected] |
$openMarkedContent = false [protected] |
$original_lMargin [protected] |
$original_rMargin [protected] |
$OutlineRoot [protected] |
$outlines = array() [protected] |
$page_obj_id = array() [protected] |
$page_regions = array() [protected] |
$PageAnnots = array() [protected] |
$PageBreakTrigger [protected] |
$pagegroups = array() [protected] |
$pagelen = array() [protected] |
$PageMode [protected] |
$pageopen = array() [protected] |
$pdfa_mode = false [protected] |
$pdflayers = array() [protected] |
$pdfunit = 'mm' [protected] |
$premode = false [protected] |
$print_footer = true [protected] |
$print_header = true [protected] |
$radio_groups = array() [protected] |
$radiobutton_groups = array() [protected] |
$rasterize_vector_images = false [protected] |
$re_spaces = '/[^\S\xa0]/' [protected] |
$rtl = false [protected] |
$sig_annot_ref = '***SIGANNREF*** 0 R' [protected] |
$sig_obj_id = 0 [protected] |
$sign = false [protected] |
$signature_data = array() [protected] |
$signature_max_length = 11742 [protected] |
$spot_colors = array() [protected] |
$spotcolor = array() [protected] |
$start_transaction_page = 0 [protected] |
Store page number when startTransaction() is called.
$start_transaction_y = 0 [protected] |
Store Y position when startTransaction() is called.
$starting_page_number = 1 [protected] |
$strokecolor [protected] |
$svgclipid = 0 [protected] |
$svgclipmode = false [protected] |
$svgclippaths = array() [protected] |
$svgcliptm = array() [protected] |
$svgdefs = array() [protected] |
$svgdefsmode = false [protected] |
$svgdir = '' [protected] |
$svggradientid = 0 [protected] |
$svggradients = array() [protected] |
$svginheritprop = array('clip-rule', 'color', 'color-interpolation', 'color-interpolation-filters', 'color-profile', 'color-rendering', 'cursor', 'direction', 'fill', 'fill-opacity', 'fill-rule', 'font', 'font-family', 'font-size', 'font-size-adjust', 'font-stretch', 'font-style', 'font-variant', 'font-weight', 'glyph-orientation-horizontal', 'glyph-orientation-vertical', 'image-rendering', 'kerning', 'letter-spacing', 'marker', 'marker-end', 'marker-mid', 'marker-start', 'pointer-events', 'shape-rendering', 'stroke', 'stroke-dasharray', 'stroke-dashoffset', 'stroke-linecap', 'stroke-linejoin', 'stroke-miterlimit', 'stroke-opacity', 'stroke-width', 'text-anchor', 'text-rendering', 'visibility', 'word-spacing', 'writing-mode') [protected] |
$svgstyles [protected] |
$svgtext = '' [protected] |
$svgtextmode = array() [protected] |
$svgunit = 'px' [protected] |
$tagvspaces = array() [protected] |
$tempfontsize = 10 [protected] |
$textindent = 0 [protected] |
$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.
$textstrokewidth = 0 [protected] |
$thead = '' [protected] |
$theadMargins = array() [protected] |
$tmprtl = false [protected] |
$tocpage = false [protected] |
$transfmatrix = array() [protected] |
$transfmatrix_key = 0 [protected] |
$transfmrk = array() [protected] |
$unicode [protected] |
$ur = array() [protected] |
$viewer_preferences [protected] |
$webcolor = array() [protected] |
$x [protected] |
$xobjects = array() [protected] |
$xobjid = '' [protected] |
$y [protected] |
1.7.6.1 
