| [ Index ] |
PHP Cross Reference of Unnamed Project |
[Source view] [Print] [Project Stats]
HTML2PDF Librairy - myPdf class
| Author: | Laurent MINGUET <webmaster@html2pdf.fr> |
| Version: | 4.03 |
| File Size: | 1415 lines (44 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
HTML2PDF_myPdf:: (56 methods):
__construct()
SetMyFooter()
Footer()
cloneFontFrom()
getFonts()
getFontFiles()
getDiffs()
getFontList()
getNumFonts()
getFontKeys()
getFontObjIds()
getAnnotFonts()
isLoadedFont()
getWordSpacing()
setWordSpacing()
clippingPathStart()
clippingPathStop()
drawCurve()
drawCorner()
startTransform()
stopTransform()
setTranslate()
setRotation()
SetX()
SetY()
SetXY()
getK()
getW()
getH()
getlMargin()
getrMargin()
gettMargin()
getbMargin()
setbMargin()
svgSetStyle()
svgRect()
svgLine()
svgEllipse()
svgPolygone()
_Point()
_Line()
_Curve()
_Arc()
_Arc2()
ptTransform()
doTransform()
undoTransform()
myBarcode()
createIndex()
getMyAliasNbPages()
getMyNumPage()
myStartPageGroup()
getMyLastPageGroup()
setMyLastPageGroup()
getMyLastPageGroupNb()
setMyLastPageGroupNb()
Class: HTML2PDF_myPdf - X-Ref
| __construct($orientation='P',$unit='mm',$format='A4',$unicode=true,$encoding='UTF-8',$diskcache=false) X-Ref |
| class constructor param: string $orientation page orientation, same as TCPDF param: string $unit User measure unit, same as TCPDF param: mixed $format The format used for pages, same as TCPDF param: boolean $unicode TRUE means that the input text is unicode (default = true) param: String $encoding charset encoding; default is UTF-8 param: boolean $diskcache if TRUE reduce the RAM memory usage by caching temporary data on filesystem (slower). |
| SetMyFooter($page = false, $date = false, $hour = false, $form = false) X-Ref |
| Set the parameters for the automatic footer param: boolean $page display the page number param: boolean $date display the date param: boolean $hour display the hour param: boolean $form display a warning abour forms |
| Footer() X-Ref |
| This function is call automatically by TCPDF at the end of a page It takes no parameters |
| cloneFontFrom(&$pdf) X-Ref |
| after cloning a object, we does not want to clone all the front informations because it take a lot a time and a lot of memory => we use reference param: &HTML2PDF_myPdf object |
| getFonts() X-Ref |
| multiple public accessor for some private attributs used only by cloneFontFrom return: &array |
| getFontFiles() X-Ref |
| No description |
| getDiffs() X-Ref |
| No description |
| getFontList() X-Ref |
| No description |
| getNumFonts() X-Ref |
| No description |
| getFontKeys() X-Ref |
| No description |
| getFontObjIds() X-Ref |
| No description |
| getAnnotFonts() X-Ref |
| No description |
| isLoadedFont($fontKey) X-Ref |
| Verify that a Font is already loaded param: string Font Key return: boolean |
| getWordSpacing() X-Ref |
| Get the Word Spacing return: float word spacing |
| setWordSpacing($ws=0.) X-Ref |
| set the Word Spacing param: float word spacing |
| clippingPathStart($x = null,$y = null,$w = null,$h = null,$cornerTL=null,$cornerTR=null,$cornerBL=null,$cornerBR=null) X-Ref |
| start to use a rectangular Cliping Path with radius corners param: float $x (top left corner) param: float $y (top left corner) param: float $w (x+w = botom rigth corner) param: float $h (y+h = botom rigth corner) param: array $cornerTL radius of the Top Left corner param: array $cornerTR radius of the Top Right corner param: array $cornerBL radius of the Bottom Left corner param: array $cornerBR radius of the Bottom Right corner |
| clippingPathStop() X-Ref |
| stop to use the Cliping Path |
| drawCurve($ext1X, $ext1Y, $ext2X, $ext2Y, $int1X, $int1Y, $int2X, $int2Y, $cenX, $cenY) X-Ref |
| draw a filled corner of a border with a external and a internal radius /--------+ ext2 / | / /-------+ int2 / / | / | | | | ext1 +-+ int1 + cen param: float $ext1X param: float $ext1Y param: float $ext2X param: float $ext2Y param: float $int1X param: float $int1Y param: float $int2X param: float $int2Y param: float $cenX param: float $cenY |
| drawCorner($ext1X, $ext1Y, $ext2X, $ext2Y, $intX, $intY, $cenX, $cenY) X-Ref |
| draw a filled corner of a border with only a external radius /--+ ext2 / | / | / | | | | | | | ext1 +-----+ int + cen param: float $ext1X param: float $ext1Y param: float $ext2X param: float $ext2Y param: float $intX param: float $intY param: float $cenX param: float $cenY |
| startTransform() X-Ref |
| Start a transformation |
| stopTransform() X-Ref |
| Stop a transformation |
| setTranslate($xT, $yT) X-Ref |
| add a Translate transformation param: float $Tx param: float $Ty |
| setRotation($angle, $xC=null, $yC=null) X-Ref |
| add a Rotate transformation param: float $angle param: float $Cx param: float $Cy |
| SetX($x, $rtloff=false) X-Ref |
| we redifine the original SetX method, because we don't want the automatic treatment. It is HTML2PDF that make the treatment param: float $x param: boolean $rtloff NOT USED |
| SetY($y, $resetx=true, $rtloff=false) X-Ref |
| we redifine the original SetY method, because we don't want the automatic treatment. It is HTML2PDF that make the treatment param: float $y param: boolean $resetx Reset the X position param: boolean $rtloff NOT USED |
| SetXY($x, $y, $rtloff=false) X-Ref |
| we redifine the original SetXY method, because we don't want the automatic treatment. It is HTML2PDF that make the treatment param: integer $x param: integer $y param: boolean $rtloff NOT USED |
| getK() X-Ref |
| multiple public accessor because HTML2PDF need to use TCPDF without being a extend of it param: mixed return: mixed |
| getW() X-Ref |
| No description |
| getH() X-Ref |
| No description |
| getlMargin() X-Ref |
| No description |
| getrMargin() X-Ref |
| No description |
| gettMargin() X-Ref |
| No description |
| getbMargin() X-Ref |
| No description |
| setbMargin($v) X-Ref |
| No description |
| svgSetStyle($styles) X-Ref |
| SVG - Convert a SVG Style in PDF Style param: array $styles SVG Style return: string PDF style |
| svgRect($x, $y, $w, $h, $style) X-Ref |
| SVG - make a Rectangle param: float $x param: float $y param: float $w param: float $h param: string $style PDF Style |
| svgLine($x1, $y1, $x2, $y2) X-Ref |
| SVG - make a Line param: float $x1 param: float $y1 param: float $x2 param: float $y2 |
| svgEllipse($x0, $y0, $rx, $ry, $style) X-Ref |
| SVG - make a Ellipse param: float $x0 x Center param: float $y0 y Center param: float $rx x radius param: float $ry y radius param: string $style PDF Style |
| svgPolygone($actions, $style) X-Ref |
| SVG - make a Advanced Polygone param: array $actions list of actions param: string $style PDF Style |
| _Point($x, $y, $trans = false) X-Ref |
| SVG - go to a point param: float $x param: float $y param: boolean $trans apply transformation |
| _Line($x, $y, $trans = false) X-Ref |
| SVG - make a line from the last point to (x,y) param: float $x param: float $y param: boolean $trans apply transformation |
| _Curve($x1, $y1, $x2, $y2, $xf, $yf, $trans = false) X-Ref |
| SVG - make a bezier curve from the last point to (xf,yf), with the 2 direction points (x1,y1) and (x2,y2) param: float $x1 param: float $y1 param: float $x2 param: float $y2 param: float $xf param: float $yf param: boolean $trans apply transformation |
| _Arc($xc,$yc,$rx,$ry,$angleBegin,$angleEnd,$direction = true,$drawFirst = true,$trans=false) X-Ref |
| SVG - make a arc with Center, Radius, from angleBegin to angleEnd param: float $xc param: float $yc param: float $rx param: float $ry param: float $angleBegin in radians param: float $angleEng in radians param: boolean $direction param: boolean $drawFirst, true => add the first point param: boolean $trans apply transformation |
| _Arc2($x1, $y1, $x2, $y2, $rx, $ry, $angle=0., $l=0, $s=0, $trans = false) X-Ref |
| SVG - make a arc from Pt1 to Pt2, with Radius param: float $x1 param: float $y1 param: float $x2 param: float $y2 param: float $rx param: float $ry param: float $angle deviation angle of the axis X param: boolean $l large-arc-flag param: boolean $s sweep-flag param: boolean $trans apply transformation |
| ptTransform(&$x, &$y, $trans=true) X-Ref |
| SVG - transform the point (reference) param: float &$x param: float &$y param: boolean $trans true => convert into PDF unit return: boolean |
| doTransform($n = null) X-Ref |
| SVG - add a transformation Matric param: array $n matrix |
| undoTransform() X-Ref |
| SVG - remove a transformation Matric |
| myBarcode($code, $type, $x, $y, $w, $h, $labelFontsize, $color) X-Ref |
| Convert a HTML2PDF barcode in a TCPDF barcode param: string $code code to print param: string $type type of barcode (see tcpdf/barcodes.php for supported formats) param: int $x x position in user units param: int $y y position in user units param: int $w width in user units param: int $h height in user units param: int $labelFontsize of the Test Label. If false : no Label param: array $color color of the foreground |
| createIndex(&$obj,$titre = 'Index',$sizeTitle = 20,$sizeBookmark = 15,$bookmarkTitle = true,$displayPage = true,$page = null,$fontName = 'helvetica') X-Ref |
| create a automatic Index on a page param: html2pdf $obj parent object param: string $titre Title of the Index Page param: integer $sizeTitle Font size for hthe Title param: integer $sizeBookmark Font size for the bookmarks param: boolean $bookmarkTitle Bookmark the Title param: boolean $displayPage Display the page number for each bookmark param: integer $page draw the automatic Index on a specific Page. if null => add a page at the end param: string $fontName FontName to use |
| getMyAliasNbPages() X-Ref |
| Returns the string alias used for the total number of pages. return: string; |
| getMyNumPage($page=null) X-Ref |
| Returns the current page number. param: integer $page return: integer; |
| myStartPageGroup() X-Ref |
| Start a new group of pages return: integer; |
| getMyLastPageGroup() X-Ref |
| get $_myLastPageGroup; return: integer $_myLastPageGroup; |
| setMyLastPageGroup($myLastPageGroup) X-Ref |
| set $_myLastPageGroup; param: integer $myLastPageGroup; |
| getMyLastPageGroupNb() X-Ref |
| get $_myLastPageGroupNb; return: integer $_myLastPageGroupNb; |
| setMyLastPageGroupNb($myLastPageGroupNb) X-Ref |
| set $_myLastPageGroupNb; param: integer $myLastPageGroupNb; |
| Generated: Tue Mar 17 22:47:18 2015 | Cross-referenced by PHPXref 0.7.1 |