| [ Index ] |
PHP Cross Reference of Joomla 1.5.26 DE |
[Source view] [Print] [Project Stats]
This is a PHP5 class for generating PDF files on-the-fly without requiring external extensions.<br> TCPDF project (http://tcpdf.sourceforge.net) has been originally derived from the Public Domain FPDF class by Olivier Plathey (http://www.fpdf.org).<br> <h3>TCPDF main features are:</h3> <ul> <li>supports all ISO page formats;</li> <li>supports UTF-8 Unicode and Right-To-Left languages;</li> <li>supports document encryption;</li> <li>includes methods to publish some xhtml code, supporting the following elements: h1, h2, h3, h4, h5, h6, b, u, i, a, img, p, br, strong, em, font, blockquote, li, ul, ol, hr, td, th, tr, table, sup, sub, small;</li> <li>includes a method to print various barcode formats using an improved version of "Generic Barcode Render Class" by Karim Mribti (<a href="http://www.mribti.com/barcode/" target="_blank" title="Generic Barcode Render Class by Karim Mribti">http://www.mribti.com/barcode/</a>) (require GD library: <a href="http://www.boutell.com/gd/" target="_blank" title="GD library">http://www.boutell.com/gd/</a>)</li> <li>supports TrueTypeUnicode, TrueType, Type1 and encoding; </li> <li>supports custom page formats, margins and units of measure;</li> <li>includes methods for page header and footer management;</li> <li>supports automatic page break;</li> <li>supports automatic page numbering;</li> <li>supports automatic line break and text justification;</li> <li>supports JPEG, PNG anf GIF images;</li> <li>supports colors;</li> <li>supports links;</li> <li>support page compression (require zlib extension: <a href="http://www.gzip.org/zlib/" target="_blank" title="zlib">http://www.gzip.org/zlib/</a>);</li> <li>the source code is full documented in PhpDocumentor Style (<a href="http://www.phpdoc.org" target="_blank" title="phpDocumentor">http://www.phpdoc.org</a>).</li> </ul> Tools to encode your unicode fonts are on fonts/ttf2ufm directory.</p>
| Author: | Nicola Asuni |
| Copyright: | 2004-2008 Nicola Asuni - Tecnick.com S.r.l (www.tecnick.com) Via Della Pace, 11 - 09044 - Quartucciu (CA) - ITALY - www.tecnick.com - info@tecnick.com |
| License: | http://www.gnu.org/copyleft/lesser.html LGPL |
| Version: | 2.5.000_PHP4 |
| File Size: | 6997 lines (232 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
TCPDF:: (176 methods):
TCPDF()
setRTL()
setTempRTL()
setLastH()
setImageScale()
getImageScale()
getPageWidth()
getPageHeight()
getBreakMargin()
getScaleFactor()
SetMargins()
SetLeftMargin()
SetTopMargin()
SetRightMargin()
SetCellPadding()
SetAutoPageBreak()
SetDisplayMode()
SetCompression()
SetTitle()
SetSubject()
SetAuthor()
SetKeywords()
SetCreator()
AliasNbPages()
Error()
Open()
Close()
lastPage()
setPage()
getPage()
getNumPages()
AddPage()
setHeaderData()
setHeaderMargin()
setFooterMargin()
setPrintHeader()
setPrintFooter()
Header()
Footer()
PageNo()
SetDrawColor()
SetFillColor()
SetTextColor()
GetStringWidth()
GetArrStringWidth()
GetCharWidth()
GetNumChars()
AddFont()
SetFont()
SetFontSize()
AddLink()
SetLink()
Link()
Text()
AcceptPageBreak()
Cell()
MultiCell()
Write()
UTF8ArrSubString()
unichr()
Image()
Ln()
GetX()
GetAbsX()
GetY()
SetX()
SetY()
SetXY()
Output()
_dochecks()
_getfontpath()
_begindoc()
_putpages()
_putfonts()
_putimages()
_putxobjectdict()
_putresourcedict()
_putresources()
_putinfo()
_putcatalog()
_puttrailer()
_putheader()
_enddoc()
_beginpage()
_endpage()
_newobj()
_dounderline()
_parsejpg()
_parsegif()
_parsepng()
_legacyparsejpg()
_legacyparsepng()
toJPEG()
outputjpg()
_freadint()
_textstring()
_uristring()
_escapetext()
_escape()
_putstream()
_out()
_puttruetypeunicode()
UTF8StringToArray()
UTF8ToUTF16BE()
arrUTF8ToUTF16BE()
setHeaderFont()
setFooterFont()
setLanguageArray()
setBarcode()
writeBarcode()
getPDFData()
writeHTML()
writeHTMLCell()
openHTMLTagHandler()
closedHTMLTagHandler()
setStyle()
addHtmlLink()
convertColorHexToDec()
pixelsToMillimeters()
unhtmlentities()
_objectkey()
_putencryption()
_RC4()
_md5_16()
_Ovalue()
_Uvalue()
_generateencryptionkey()
SetProtection()
StartTransform()
StopTransform()
ScaleX()
ScaleY()
ScaleXY()
Scale()
MirrorH()
MirrorV()
MirrorP()
MirrorL()
TranslateX()
TranslateY()
Translate()
Rotate()
SkewX()
SkewY()
Skew()
Transform()
SetLineWidth()
GetLineWidth()
SetLineStyle()
_outPoint()
_outLine()
_outRect()
_outCurve()
Line()
Rect()
Curve()
Ellipse()
Circle()
Polygon()
RegularPolygon()
StarPolygon()
RoundedRect()
utf8StrRev()
utf8Bidi()
Bookmark()
_putbookmarks()
IncludeJS()
_putjavascript()
_JScolor()
_addfield()
TextField()
RadioButton()
ListBox()
ComboBox()
CheckBox()
Button()
| TCPDF($orientation='P', $unit='mm', $format='A4', $unicode=true, $encoding="UTF-8") X-Ref |
| 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). param: string $orientation page orientation. Possible values are (case insensitive):<ul><li>P or Portrait (default)</li><li>L or Landscape</li></ul> param: string $unit User measure unit. Possible values are:<ul><li>pt: point</li><li>mm: millimeter (default)</li><li>cm: centimeter</li><li>in: inch</li></ul><br />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. param: mixed $format The format used for pages. It can be either one of the following values (case insensitive) or a custom format in the form of a two-element array containing the width and the height (expressed in the unit given by unit).<ul><li>4A0</li><li>2A0</li><li>A0</li><li>A1</li><li>A2</li><li>A3</li><li>A4 (default)</li><li>A5</li><li>A6</li><li>A7</li><li>A8</li><li>A9</li><li>A10</li><li>B0</li><li>B1</li><li>B2</li><li>B3</li><li>B4</li><li>B5</li><li>B6</li><li>B7</li><li>B8</li><li>B9</li><li>B10</li><li>C0</li><li>C1</li><li>C2</li><li>C3</li><li>C4</li><li>C5</li><li>C6</li><li>C7</li><li>C8</li><li>C9</li><li>C10</li><li>RA0</li><li>RA1</li><li>RA2</li><li>RA3</li><li>RA4</li><li>SRA0</li><li>SRA1</li><li>SRA2</li><li>SRA3</li><li>SRA4</li><li>LETTER</li><li>LEGAL</li><li>EXECUTIVE</li><li>FOLIO</li></ul> param: boolean $unicode TRUE means that the input text is unicode (default = true) param: String $encoding charset encoding; default is UTF-8 |
| setRTL($enable) X-Ref |
| Enable or disable Right-To-Left language mode param: Boolean $enable if true enable Right-To-Left language mode. |
| setTempRTL($mode) X-Ref |
| Force temporary RTL language direction param: mixed $mode can be false, 'L' for LTR or 'R' for RTL |
| setLastH($h) X-Ref |
| Set the last cell height. author: Nicola Asuni param: float $h cell height. |
| setImageScale($scale) X-Ref |
| Set the image scale. author: Nicola Asuni param: float $scale image scale. |
| getImageScale() X-Ref |
| Returns the image scale. author: Nicola Asuni return: float image scale. |
| getPageWidth() X-Ref |
| Returns the page width in units. author: Nicola Asuni return: int page width. |
| getPageHeight() X-Ref |
| Returns the page height in units. author: Nicola Asuni return: int page height. |
| getBreakMargin() X-Ref |
| Returns the page break margin. author: Nicola Asuni return: int page break margin. |
| getScaleFactor() X-Ref |
| Returns the scale factor (number of points in user unit). author: Nicola Asuni return: int scale factor. |
| SetMargins($left, $top, $right=-1) X-Ref |
| Defines the left, top and right margins. By default, they equal 1 cm. Call this method to change them. param: float $left Left margin. param: float $top Top margin. param: float $right Right margin. Default value is the left one. |
| SetLeftMargin($margin) X-Ref |
| 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. param: float $margin The margin. |
| SetTopMargin($margin) X-Ref |
| Defines the top margin. The method can be called before creating the first page. param: float $margin The margin. |
| SetRightMargin($margin) X-Ref |
| Defines the right margin. The method can be called before creating the first page. param: float $margin The margin. |
| SetCellPadding($pad) X-Ref |
| Set the internal Cell padding. param: float $pad internal padding. |
| SetAutoPageBreak($auto, $margin=0) X-Ref |
| 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. param: boolean $auto Boolean indicating if mode should be on or off. param: float $margin Distance from the bottom of the page. |
| SetDisplayMode($zoom, $layout='continuous') X-Ref |
| Defines the way the document is to be displayed by the viewer. The zoom level can be set: pages can be displayed entirely on screen, occupy the full width of the window, use real size, be scaled by a specific zooming factor or use viewer default (configured in the Preferences menu of Acrobat). The page layout can be specified too: single at once, continuous display, two columns or viewer default. By default, documents use the full width mode with continuous display. param: mixed $zoom The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use. <ul><li>fullpage: displays the entire page on screen </li><li>fullwidth: uses maximum width of window</li><li>real: uses real size (equivalent to 100% zoom)</li><li>default: uses viewer default mode</li></ul> param: string $layout The page layout. Possible values are:<ul><li>single: displays one page at once</li><li>continuous: displays pages continuously (default)</li><li>two: displays two pages on two columns</li><li>default: uses viewer default mode</li></ul> |
| SetCompression($compress) X-Ref |
| 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. param: boolean $compress Boolean indicating if compression must be enabled. |
| SetTitle($title) X-Ref |
| Defines the title of the document. param: string $title The title. |
| SetSubject($subject) X-Ref |
| Defines the subject of the document. param: string $subject The subject. |
| SetAuthor($author) X-Ref |
| Defines the author of the document. param: string $author The name of the author. |
| SetKeywords($keywords) X-Ref |
| Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'. param: string $keywords The list of keywords. |
| SetCreator($creator) X-Ref |
| Defines the creator of the document. This is typically the name of the application that generates the PDF. param: string $creator The name of the creator. |
| AliasNbPages($alias='{nb}') X-Ref |
| Defines an alias for the total number of pages. It will be substituted as the document is closed.<br /> <b>Example:</b><br /> <pre> class PDF extends TCPDF { function Footer() { //Go to 1.5 cm from bottom $this->SetY(-15); //Select Arial italic 8 $this->SetFont('vera','I',8); //Print current and total page numbers $this->Cell(0,10,'Page '.$this->PageNo().'/{nb}',0,0,'C'); } } $pdf=new PDF(); $pdf->AliasNbPages(); </pre> param: string $alias The alias. Default value: {nb}. |
| Error($msg) X-Ref |
| 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 param: string $msg The error message |
| Open() X-Ref |
| This method begins the generation of the PDF document. It is not necessary to call it explicitly because AddPage() does it automatically. Note: no page is created by this method |
| Close() X-Ref |
| 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. |
| lastPage() X-Ref |
| Reset pointer to the last document page. |
| setPage($pnum) X-Ref |
| Move pointer to the apecified document page. param: int $pnum page number |
| getPage() X-Ref |
| Get current document page number. return: int page number |
| getNumPages() X-Ref |
| Get the total number of insered pages. return: int number of pages |
| AddPage($orientation='') X-Ref |
| Adds a new page to the document. If a page is already present, the Footer() method is called first to output the footer. Then the page is added, the current position set to the top-left corner according to the left and top margins, and Header() is called to display the header. The font which was set before calling is automatically restored. There is no need to call SetFont() again if you want to continue with the same font. The same is true for colors and line width. The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards. param: string $orientation Page orientation. Possible values are (case insensitive):<ul><li>P or Portrait</li><li>L or Landscape</li></ul> The default value is the one passed to the constructor. |
| setHeaderData($ln="", $lw=0, $ht="", $hs="") X-Ref |
| Set header data. param: string $ln header image logo param: string $lw header image logo width in mm param: string $ht string to print as title on document header param: string $hs string to print on document header |
| setHeaderMargin($hm=10) X-Ref |
| Set header margin. (minimum distance between header and top page margin) param: int $hm distance in millimeters |
| setFooterMargin($fm=10) X-Ref |
| Set footer margin. (minimum distance between footer and bottom page margin) param: int $fm distance in millimeters |
| setPrintHeader($val=true) X-Ref |
| Set a flag to print page header. param: boolean $val set to true to print the page header (default), false otherwise. |
| setPrintFooter($val=true) X-Ref |
| Set a flag to print page footer. param: boolean $value set to true to print the page footer (default), false otherwise. |
| Header() X-Ref |
| This method is used to render the page header. It is automatically called by AddPage() and could be overwritten in your own inherited class. |
| Footer() X-Ref |
| This method is used to render the page footer. It is automatically called by AddPage() and could be overwritten in your own inherited class. |
| PageNo() X-Ref |
| Returns the current page number. return: int page number |
| SetDrawColor($r, $g=-1, $b=-1) X-Ref |
| 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. param: int $r If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255 param: int $g Green component (between 0 and 255) param: int $b Blue component (between 0 and 255) |
| SetFillColor($r, $g=-1, $b=-1, $storeprev=false) X-Ref |
| 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. param: int $r If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255 param: int $g Green component (between 0 and 255) param: int $b Blue component (between 0 and 255) param: boolean $storeprev if true stores the RGB array on $prevFillColor variable. |
| SetTextColor($r, $g=-1, $b=-1, $storeprev=false) X-Ref |
| 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. param: int $r If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255 param: int $g Green component (between 0 and 255) param: int $b Blue component (between 0 and 255) param: boolean $storeprev if true stores the RGB array on $prevTextColor variable. |
| GetStringWidth($s) X-Ref |
| Returns the length of a string in user unit. A font must be selected.<br> author: Nicola Asuni param: string $s The string whose length is to be computed return: int string length |
| GetArrStringWidth($sa) X-Ref |
| Returns the string length of an array of chars in user unit. A font must be selected.<br> author: Nicola Asuni param: string $arr The array of chars whose total length is to be computed return: int string length |
| GetCharWidth($char) X-Ref |
| Returns the length of the char in user unit. A font must be selected.<br> author: Nicola Asuni param: string $char The char whose length is to be returned return: int char width |
| GetNumChars($s) X-Ref |
| Returns the numbero of characters in a string. param: string $s The input string. return: int number of characters |
| AddFont($family, $style='', $file='') X-Ref |
| Imports a TrueType or Type1 font and makes it available. It is necessary to generate a font definition file first with the makefont.php utility. 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. Support UTF-8 Unicode [Nicola Asuni, 2005-01-02]. <b>Example</b>:<br /> <pre> $pdf->AddFont('Comic','I'); // is equivalent to: $pdf->AddFont('Comic','I','comici.php'); </pre> param: string $family Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font. param: string $style Font style. Possible values are (case insensitive):<ul><li>empty string: regular (default)</li><li>B: bold</li><li>I: italic</li><li>BI or IB: bold italic</li></ul> param: string $file The font definition file. By default, the name is built from the family and style, in lower case with no space. |
| SetFont($family, $style='', $size=0) X-Ref |
| Sets the font used to print character strings. It is mandatory to call this method at least once before printing text or the resulting document would not be valid. 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. Note: for the standard fonts, the font metric files must be accessible. There are three possibilities for this:<ul><li>They are in the current directory (the one where the running script lies)</li><li>They are in one of the directories defined by the include_path parameter</li><li>They are in the directory defined by the K_PATH_FONTS constant</li></ul><br /> Example for the last case (note the trailing slash):<br /> <pre> define('K_PATH_FONTS','/home/www/font/'); require('tcpdf.php'); //Times regular 12 $pdf->SetFont('Times'); //Arial bold 14 $pdf->SetFont('vera','B',14); //Removes bold $pdf->SetFont(''); //Times bold, italic and underlined 14 $pdf->SetFont('Times','BIU'); </pre><br /> If the file corresponding to the requested font is not found, the error "Could not include font metric file" is generated. param: string $family Family font. It can be either a name defined by AddFont() or one of the standard families (case insensitive):<ul><li>Courier (fixed-width)</li><li>Helvetica or Arial (synonymous; sans serif)</li><li>Times (serif)</li><li>Symbol (symbolic)</li><li>ZapfDingbats (symbolic)</li></ul>It is also possible to pass an empty string. In that case, the current family is retained. param: string $style Font style. Possible values are (case insensitive):<ul><li>empty string: regular</li><li>B: bold</li><li>I: italic</li><li>U: underline</li></ul>or any combination. The default value is regular. Bold and italic styles do not apply to Symbol and ZapfDingbats param: float $size 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 |
| SetFontSize($size) X-Ref |
| Defines the size of the current font. param: float $size The size (in points) |
| AddLink() X-Ref |
| Creates a new internal link and returns its identifier. An internal link is a clickable area which directs to another place within the document.<br /> The identifier can then be passed to Cell(), Write(), Image() or Link(). The destination is defined with SetLink(). |
| SetLink($link, $y=0, $page=-1) X-Ref |
| Defines the page and position a link points to param: int $link The link identifier returned by AddLink() param: float $y Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page) param: int $page Number of target page; -1 indicates the current page. This is the default value |
| Link($x, $y, $w, $h, $link) X-Ref |
| 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. param: float $x Abscissa of the upper-left corner of the rectangle (or upper-right for RTL languages) param: float $y Ordinate of the upper-left corner of the rectangle (or upper-right for RTL languages) param: float $w Width of the rectangle param: float $h Height of the rectangle param: mixed $link URL or identifier returned by AddLink() |
| Text($x, $y, $txt) X-Ref |
| Prints a character string. The origin is on the left of the first charcter, on the baseline. This method allows to place a string precisely on the page, but it is usually easier to use Cell(), MultiCell() or Write() which are the standard methods to print text. param: float $x Abscissa of the origin param: float $y Ordinate of the origin param: string $txt String to print |
| AcceptPageBreak() X-Ref |
| 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().<br /> This method is called automatically and should not be called directly by the application.<br /> <b>Example:</b><br /> The method is overriden in an inherited class in order to obtain a 3 column layout:<br /> <pre> class PDF extends TCPDF { var $col=0; function SetCol($col) { //Move position to a column $this->col=$col; $x=10+$col*65; $this->SetLeftMargin($x); $this->SetX($x); } function AcceptPageBreak() { if($this->col<2) { //Go to next column $this->SetCol($this->col+1); $this->SetY(10); return false; } else { //Go back to first column and issue page break $this->SetCol(0); return true; } } } $pdf=new PDF(); $pdf->Open(); $pdf->AddPage(); $pdf->SetFont('vera','',12); for($i=1;$i<=300;$i++) { $pdf->Cell(0,5,"Line $i",0,1); } $pdf->Output(); </pre> return: boolean |
| Cell($w, $h=0, $txt='', $border=0, $ln=0, $align='', $fill=0, $link='', $stretch=0) X-Ref |
| 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.<br /> If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting. param: float $w Cell width. If 0, the cell extends up to the right margin. param: float $h Cell height. Default value: 0. param: string $txt String to print. Default value: empty string. param: mixed $border Indicates if borders must be drawn around the cell. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> param: int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL languages)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul> param: string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align (default value)</li><li>C: center</li><li>R: right align</li><li>J: justify</li></ul> param: int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0. param: mixed $link URL or identifier returned by AddLink(). param: int $stretch stretch carachter mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if necessary</li><li>4 = forced character spacing</li></ul> |
| MultiCell($w, $h, $txt, $border=0, $align='J', $fill=0, $ln=1, $x='', $y='', $reseth=true, $stretch=0) X-Ref |
| 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 \n character). As many cells as necessary are output, one below the other.<br /> Text can be aligned, centered or justified. The cell block can be framed and the background painted. param: float $w Width of cells. If 0, they extend up to the right margin of the page. param: float $h Cell minimum height. The cell extends automatically if needed. param: string $txt String to print param: mixed $border Indicates if borders must be drawn around the cell block. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> param: string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align</li><li>C: center</li><li>R: right align</li><li>J: justification (default value)</li></ul> param: int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0. param: int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right</li><li>1: to the beginning of the next line [DEFAULT]</li><li>2: below</li></ul> param: int $x x position in user units param: int $y y position in user units param: boolean $reseth if true reset the last cell height (default true). param: int $stretch stretch carachter mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if necessary</li><li>4 = forced character spacing</li></ul> return: int Rerurn the number of lines. |
| Write($h, $txt, $link='', $fill=0, $align='', $ln=false, $stretch=0) X-Ref |
| This method prints text from the current position.<br /> param: float $h Line height param: string $txt String to print param: mixed $link URL or identifier returned by AddLink() param: int $fill Indicates if the background must be painted (1) or transparent (0). Default value: 0. param: string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align (default value)</li><li>C: center</li><li>R: right align</li><li>J: justify</li></ul> param: boolean $ln if true set cursor at the bottom of the line, otherwise set cursor at the top of the line. param: int $stretch stretch carachter mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if necessary</li><li>4 = forced character spacing</li></ul> return: int Rerurn the number of lines. |
| UTF8ArrSubString($strarr, $start='', $end='') X-Ref |
| Extract a slice of the $strarr array and return it as string. param: string $strarr The input array of characters. param: int $start the starting element of $strarr. param: int $end first element that will not be returned. return: Return part of a string |
| unichr($c) X-Ref |
| Returns the unicode caracter specified by UTF-8 code author: Miguel Perez, Nicola Asuni param: int $c UTF-8 code return: Returns the specified character. |
| Image($file, $x, $y, $w=0, $h=0, $type='', $link='', $align='') X-Ref |
| Puts an image in the page. The upper-left corner must be given. The dimensions can be specified in different ways:<ul><li>explicit width and height (expressed in user unit)</li><li>one explicit dimension, the other being calculated automatically in order to keep the original proportions</li><li>no explicit dimension, in which case the image is put at 72 dpi</li></ul> Supported formats are JPEG and PNG. For JPEG, all flavors are allowed:<ul><li>gray scales</li><li>true colors (24 bits)</li><li>CMYK (32 bits)</li></ul> For PNG, are allowed:<ul><li>gray scales on at most 8 bits (256 levels)</li><li>indexed colors</li><li>true colors (24 bits)</li></ul> If a transparent color is defined, it will be taken into account (but will be only interpreted by Acrobat 4 and above).<br /> The format can be specified explicitly or inferred from the file extension.<br /> It is possible to put a link on the image.<br /> Remark: if an image is used several times, only one copy will be embedded in the file.<br /> param: string $file Name of the file containing the image. param: float $x Abscissa of the upper-left corner. param: float $y Ordinate of the upper-left corner. param: float $w Width of the image in the page. If not specified or equal to zero, it is automatically calculated. param: float $h Height of the image in the page. If not specified or equal to zero, it is automatically calculated. param: string $type Image format. Possible values are (case insensitive): JPG, JPEG, PNG. If not specified, the type is inferred from the file extension. param: mixed $link URL or identifier returned by AddLink(). param: string $align Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul> |
| Ln($h='') X-Ref |
| Performs a line break. The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter. param: float $h The height of the break. By default, the value equals the height of the last printed cell. |
| GetX() X-Ref |
| Returns the relative X value of current position. The value is relative to the left border for LTR languages and to the right border for RTL languages. return: float |
| GetAbsX() X-Ref |
| Returns the absolute X value of current position. return: float |
| GetY() X-Ref |
| Returns the ordinate of the current position. return: float |
| SetX($x) X-Ref |
| 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). param: float $x The value of the abscissa. |
| SetY($y) X-Ref |
| 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. param: float $y The value of the ordinate. |
| SetXY($x, $y) X-Ref |
| 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. param: float $x The value of the abscissa param: float $y The value of the ordinate |
| Output($name='',$dest='') X-Ref |
| 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.<br /> The method first calls Close() if necessary to terminate the document. param: string $name The name of the file. If not given, the document will be sent to the browser (destination I) with the name doc.pdf. param: string $dest Destination where to send the document. It can take one of the following values:<ul><li>I: send the file inline to the browser. The plug-in is used if available. The name given by name is used when one selects the "Save as" option on the link generating the PDF.</li><li>D: send to the browser and force a file download with the name given by name.</li><li>F: save to a local file with the name given by name.</li><li>S: return the document as a string. name is ignored.</li></ul>If the parameter is not specified but a name is given, destination is F. If no parameter is specified at all, destination is I.<br />Note: for compatibility with previous versions, a boolean value is also accepted (false for F and true for D). |
| _dochecks() X-Ref |
| Check for locale-related bug |
| _getfontpath() X-Ref |
| Return fonts path |
| _begindoc() X-Ref |
| Start document |
| _putpages() X-Ref |
| _putpages |
| _putfonts() X-Ref |
| Adds fonts _putfonts |
| _putimages() X-Ref |
| _putimages |
| _putxobjectdict() X-Ref |
| _putxobjectdict |
| _putresourcedict() X-Ref |
| _putresourcedict |
| _putresources() X-Ref |
| _putresources |
| _putinfo() X-Ref |
| _putinfo Adds some meta information |
| _putcatalog() X-Ref |
| _putcatalog |
| _puttrailer() X-Ref |
| _puttrailer |
| _putheader() X-Ref |
| _putheader |
| _enddoc() X-Ref |
| _enddoc |
| _beginpage($orientation) X-Ref |
| _beginpage |
| _endpage() X-Ref |
| End of page contents |
| _newobj() X-Ref |
| Begin a new object |
| _dounderline($x, $y, $txt) X-Ref |
| Underline text param: int $x X coordinate param: int $y Y coordinate param: string $txt text to underline |
| _parsejpg($file) X-Ref |
| Extract info from a JPEG file param: string $file image file to parse return: string |
| _parsegif($file) X-Ref |
| Extract info from a GIF file param: string $file image file to parse return: string |
| _parsepng($file) X-Ref |
| Extract info from a PNG file param: string $file image file to parse return: string |
| _legacyparsejpg($file) X-Ref |
| Extract info from a JPEG file without using GD param: string $file image file to parse return: string |
| _legacyparsepng($file) X-Ref |
| Extract info from a PNG file without using GD param: string $file image file to parse return: string |
| toJPEG($file, $image) X-Ref |
| Convert the loaded php image to a JPEG and then return a structure for the PDF creator. param: string $file Image file name. param: image $image Image object. |
| outputjpg($filename) X-Ref |
| Get a JPEG filename and return a structure for the PDF creator. param: string $filename JPEG file name. return: array structure containing the image data |
| _freadint($f) X-Ref |
| Read a 4-byte integer from file param: string $f file name. return: 4-byte integer |
| _textstring($s) X-Ref |
| Format a text string for meta information param: string $s string to escape. return: string escaped string. |
| _uristring($s) X-Ref |
| Format an URI string param: string $s string to escape. return: string escaped string. |
| _escapetext($s) X-Ref |
| Format a text string param: string $s string to escape. return: string escaped string. |
| _escape($s) X-Ref |
| Add \ before \, ( and ) param: string $s string to escape. return: string escaped string. |
| _putstream($s) X-Ref |
| Output a stream. param: string $s string to output. |
| _out($s) X-Ref |
| Output a string to the document. param: string $s string to output. |
| _puttruetypeunicode($font) X-Ref |
| Adds unicode fonts.<br> Based on PDF Reference 1.3 (section 5) author: Nicola Asuni |
| UTF8StringToArray($str) X-Ref |
| Converts UTF-8 strings to codepoints array.<br> Invalid byte sequences will be replaced with 0xFFFD (replacement character)<br> Based on: http://www.faqs.org/rfcs/rfc3629.html <pre> 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 --------------------------------------------------------------------- </pre> author: Nicola Asuni param: string $str string to process. return: array containing codepoints (UTF-8 characters values) |
| UTF8ToUTF16BE($str, $setbom=true) X-Ref |
| Converts UTF-8 strings to UTF16-BE.<br> author: Nicola Asuni param: string $str string to process. param: boolean $setbom if true set the Byte Order Mark (BOM = 0xFEFF) return: string |
| arrUTF8ToUTF16BE($unicode, $setbom=true) X-Ref |
| Converts array of UTF-8 characters to UTF16-BE string.<br> Based on: http://www.faqs.org/rfcs/rfc2781.html <pre> 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 </pre> author: Nicola Asuni param: array $unicode array containing UTF-8 unicode values param: boolean $setbom if true set the Byte Order Mark (BOM = 0xFEFF) return: string |
| setHeaderFont($font) X-Ref |
| Set header font. param: array $font font |
| setFooterFont($font) X-Ref |
| Set footer font. param: array $font font |
| setLanguageArray($language) X-Ref |
| Set language array. param: array $language |
| setBarcode($bc="") X-Ref |
| Set document barcode. param: string $bc barcode |
| writeBarcode($x, $y, $w, $h, $type, $style, $font, $xres, $code) X-Ref |
| Print Barcode. 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 position in user units param: string $type type of barcode (I25, C128A, C128B, C128C, C39) param: string $style barcode style param: string $font font for text param: int $xres x resolution param: string $code code to print |
| getPDFData() X-Ref |
| Returns the PDF data. |
| writeHTML($html, $ln=true, $fill=0, $reseth=false, $cell=false) X-Ref |
| Allows to preserve some HTML formatting.<br /> Supports: h1, h2, h3, h4, h5, h6, b, u, i, a, img, p, br, strong, em, font, blockquote, li, ul, ol, hr, td, th, tr, table, sup, sub, small param: string $html text to display param: boolean $ln if true add a new line after text (default = true) param: int $fill Indicates if the background must be painted (1) or transparent (0). Default value: 0. param: boolean $reseth if true reset the last cell height (default false). param: boolean $cell if true add the default cMargin space to each Write (default false). |
| writeHTMLCell($w, $h, $x, $y, $html='', $border=0, $ln=0, $fill=0, $reseth=true) X-Ref |
| Prints a cell (rectangular area) with optional borders, background color and html text string. The upper-left corner of the cell corresponds to the current position. After the call, the current position moves to the right or to the next line.<br /> If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting. param: float $w Cell width. If 0, the cell extends up to the right margin. param: float $h Cell minimum height. The cell extends automatically if needed. param: float $x upper-left corner X coordinate param: float $y upper-left corner Y coordinate param: string $html html text to print. Default value: empty string. param: mixed $border Indicates if borders must be drawn around the cell. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> param: int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL language)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul> param: int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0. param: boolean $reseth if true reset the last cell height (default true). |
| openHTMLTagHandler($tag, $attr, $fill=0) X-Ref |
| Process opening tags. param: string $tag tag name (in uppercase) param: string $attr tag attribute (in uppercase) param: int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0. |
| closedHTMLTagHandler($tag) X-Ref |
| Process closing tags. param: string $tag tag name (in uppercase) |
| setStyle($tag, $enable) X-Ref |
| Sets font style. param: string $tag tag name (in lowercase) param: boolean $enable |
| addHtmlLink($url, $name, $fill=0) X-Ref |
| Output anchor link. param: string $url link URL param: string $name link name param: int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0. |
| convertColorHexToDec($color = ") X-Ref |
| Returns an associative array (keys: R,G,B) from a hex html code (e.g. #3FE5AA). param: string $color hexadecimal html color [#rrggbb] return: array |
| pixelsToMillimeters($px) X-Ref |
| Converts pixels to millimeters in 72 dpi. param: int $px pixels return: float millimeters |
| unhtmlentities($text_to_convert) X-Ref |
| Reverse function for htmlentities. Convert entities in UTF-8. param: $text_to_convert Text to convert. return: string converted |
| _objectkey($n) X-Ref |
| Compute encryption key depending on object number where the encrypted data is stored param: int $n object number |
| _putencryption() X-Ref |
| Put encryption on PDF document |
| _RC4($key, $text) X-Ref |
| Returns the input text exrypted using RC4 algorithm and the specified key. RC4 is the standard encryption algorithm used in PDF format author: Klemen Vodopivec param: string $key encryption key param: String $text input text to be encrypted return: String encrypted text |
| _md5_16($str) X-Ref |
| Encrypts a string using MD5 and returns it's value as a binary string. author: Klemen Vodopivec param: string $str input string return: String MD5 encrypted binary string |
| _Ovalue($user_pass, $owner_pass) X-Ref |
| Compute O value (used for RC4 encryption) author: Klemen Vodopivec param: String $user_pass user password param: String $owner_pass user password return: String O value |
| _Uvalue() X-Ref |
| Compute U value (used for RC4 encryption) author: Klemen Vodopivec return: String U value |
| _generateencryptionkey($user_pass, $owner_pass, $protection) X-Ref |
| Compute encryption key author: Klemen Vodopivec param: String $user_pass user password param: String $owner_pass user password param: String $protection protection type |
| SetProtection($permissions=array() X-Ref |
| Set document protection The permission array is composed of values taken from the following ones: - copy: copy text and images to the clipboard - print: print the document - modify: modify it (except for annotations and forms) - annot-forms: add annotations and forms 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. author: Klemen Vodopivec param: Array $permissions the set of permissions. Empty by default (only viewing is allowed). (print, modify, copy, annot-forms) param: String $user_pass user password. Empty by default. param: String $owner_pass owner password. If not specified, a random value is used. |
| StartTransform() X-Ref |
| 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. |
| StopTransform() X-Ref |
| 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. |
| ScaleX($s_x, $x='', $y='') X-Ref |
| Horizontal Scaling. param: float $s_x scaling factor for width as percent. 0 is not allowed. param: int $x abscissa of the scaling center. Default is current x position param: int $y ordinate of the scaling center. Default is current y position |
| ScaleY($s_y, $x='', $y='') X-Ref |
| Vertical Scaling. param: float $s_y scaling factor for height as percent. 0 is not allowed. param: int $x abscissa of the scaling center. Default is current x position param: int $y ordinate of the scaling center. Default is current y position |
| ScaleXY($s, $x='', $y='') X-Ref |
| Vertical and horizontal proportional Scaling. param: float $s scaling factor for width and height as percent. 0 is not allowed. param: int $x abscissa of the scaling center. Default is current x position param: int $y ordinate of the scaling center. Default is current y position |
| Scale($s_x, $s_y, $x='', $y='') X-Ref |
| Vertical and horizontal non-proportional Scaling. param: float $s_x scaling factor for width as percent. 0 is not allowed. param: float $s_y scaling factor for height as percent. 0 is not allowed. param: int $x abscissa of the scaling center. Default is current x position param: int $y ordinate of the scaling center. Default is current y position |
| MirrorH($x='') X-Ref |
| Horizontal Mirroring. param: int $x abscissa of the point. Default is current x position |
| MirrorV($y='') X-Ref |
| Verical Mirroring. param: int $y ordinate of the point. Default is current y position |
| MirrorP($x='',$y='') X-Ref |
| Point reflection mirroring. param: int $x abscissa of the point. Default is current x position param: int $y ordinate of the point. Default is current y position |
| MirrorL($angle=0, $x='',$y='') X-Ref |
| Reflection against a straight line through point (x, y) with the gradient angle (angle). param: float $angle gradient angle of the straight line. Default is 0 (horizontal line). param: int $x abscissa of the point. Default is current x position param: int $y ordinate of the point. Default is current y position |
| TranslateX($t_x) X-Ref |
| Translate graphic object horizontally. param: int $t_x movement to the right |
| TranslateY($t_y) X-Ref |
| Translate graphic object vertically. param: int $t_y movement to the bottom |
| Translate($t_x, $t_y) X-Ref |
| Translate graphic object horizontally and vertically. param: int $t_x movement to the right param: int $t_y movement to the bottom |
| Rotate($angle, $x='', $y='') X-Ref |
| Rotate object. param: float $angle angle in degrees for counter-clockwise rotation param: int $x abscissa of the rotation center. Default is current x position param: int $y ordinate of the rotation center. Default is current y position |
| SkewX($angle_x, $x='', $y='') X-Ref |
| Skew horizontally. param: float $angle_x angle in degrees between -90 (skew to the left) and 90 (skew to the right) param: int $x abscissa of the skewing center. default is current x position param: int $y ordinate of the skewing center. default is current y position |
| SkewY($angle_y, $x='', $y='') X-Ref |
| Skew vertically. param: float $angle_y angle in degrees between -90 (skew to the bottom) and 90 (skew to the top) param: int $x abscissa of the skewing center. default is current x position param: int $y ordinate of the skewing center. default is current y position |
| Skew($angle_x, $angle_y, $x='', $y='') X-Ref |
| Skew. param: float $angle_x angle in degrees between -90 (skew to the left) and 90 (skew to the right) param: float $angle_y angle in degrees between -90 (skew to the bottom) and 90 (skew to the top) param: int $x abscissa of the skewing center. default is current x position param: int $y ordinate of the skewing center. default is current y position |
| Transform($tm) X-Ref |
| Apply graphic transformations. |
| SetLineWidth($width) X-Ref |
| 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. param: float $width The width. |
| GetLineWidth() X-Ref |
| Returns the current the line width. return: int Line width |
| SetLineStyle($style) X-Ref |
| Set line style. param: array $style Line style. Array with keys among the following: |
| _outPoint($x, $y) X-Ref |
| No description |
| _outLine($x, $y) X-Ref |
| No description |
| _outRect($x, $y, $w, $h, $op) X-Ref |
| Draws a rectangle. param: float $x Abscissa of upper-left corner (or upper-right corner for RTL language). param: float $y Ordinate of upper-left corner (or upper-right corner for RTL language). param: float $w Width. param: float $h Height. param: string $op options |
| _outCurve($x1, $y1, $x2, $y2, $x3, $y3) X-Ref |
| No description |
| Line($x1, $y1, $x2, $y2, $style = array() X-Ref |
| Draws a line between two points. param: float $x1 Abscissa of first point. param: float $y1 Ordinate of first point. param: float $x2 Abscissa of second point. param: float $y2 Ordinate of second point. param: array $style Line style. Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array). |
| Rect($x, $y, $w, $h, $style='', $border_style = array() X-Ref |
| Draws a rectangle. param: float $x Abscissa of upper-left corner (or upper-right corner for RTL language). param: float $y Ordinate of upper-left corner (or upper-right corner for RTL language). param: float $w Width. param: float $h Height. param: string $style Style of rendering. Possible values are: param: array $border_style Border style of rectangle. Array with keys among the following: param: array $fill_color Fill color. Format: array(red, green, blue). Default value: default color (empty array). |
| Curve($x0, $y0, $x1, $y1, $x2, $y2, $x3, $y3, $style = "", $line_style = array() X-Ref |
| Draws a Bezier curve. The Bezier curve is a tangent to the line between the control points at either end of the curve. param: float $x0 Abscissa of start point. param: float $y0 Ordinate of start point. param: float $x1 Abscissa of control point 1. param: float $y1 Ordinate of control point 1. param: float $x2 Abscissa of control point 2. param: float $y2 Ordinate of control point 2. param: float $x3 Abscissa of end point. param: float $y3 Ordinate of end point. param: string $style Style of rendering. Possible values are: param: array $line_style Line style of curve. Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array). param: array $fill_color Fill color. Format: array(red, green, blue). Default value: default color (empty array). |
| Ellipse($x0, $y0, $rx, $ry = 0, $angle = 0, $astart = 0, $afinish = 360, $style = "", $line_style = array() X-Ref |
| Draws an ellipse. An ellipse is formed from n Bezier curves. param: float $x0 Abscissa of center point. param: float $y0 Ordinate of center point. param: float $rx Horizontal radius. param: float $ry Vertical radius (if ry = 0 then is a circle, see {@link Circle Circle}). Default value: 0. param: float $angle: Angle oriented (anti-clockwise). Default value: 0. param: float $astart: Angle start of draw line. Default value: 0. param: float $afinish: Angle finish of draw line. Default value: 360. param: string $style Style of rendering. Possible values are: param: array $line_style Line style of ellipse. Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array). param: array $fill_color Fill color. Format: array(red, green, blue). Default value: default color (empty array). param: integer $nc Number of curves used in ellipse. Default value: 8. |
| Circle($x0, $y0, $r, $astart = 0, $afinish = 360, $style = "", $line_style = array() X-Ref |
| Draws a circle. A circle is formed from n Bezier curves. param: float $x0 Abscissa of center point. param: float $y0 Ordinate of center point. param: float $r Radius. param: float $astart: Angle start of draw line. Default value: 0. param: float $afinish: Angle finish of draw line. Default value: 360. param: string $style Style of rendering. Possible values are: param: array $line_style Line style of circle. Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array). param: array $fill_color Fill color. Format: array(red, green, blue). Default value: default color (empty array). param: integer $nc Number of curves used in circle. Default value: 8. |
| Polygon($p, $style = "", $line_style = array() X-Ref |
| Draws a polygon. param: array $p Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1)) param: string $style Style of rendering. Possible values are: param: array $line_style Line style of polygon. Array with keys among the following: param: array $fill_color Fill color. Format: array(red, green, blue). Default value: default color (empty array). |
| RegularPolygon($x0, $y0, $r, $ns, $angle = 0, $draw_circle = false, $style = "", $line_style = array() X-Ref |
| Draws a regular polygon. param: float $x0 Abscissa of center point. param: float $y0 Ordinate of center point. param: float $r: Radius of inscribed circle. param: integer $ns Number of sides. param: float $angle Angle oriented (anti-clockwise). Default value: 0. param: boolean $draw_circle Draw inscribed circle or not. Default value: false. param: string $style Style of rendering. Possible values are: param: array $line_style Line style of polygon sides. Array with keys among the following: param: array $fill_color Fill color. Format: array(red, green, blue). Default value: default color (empty array). param: string $circle_style Style of rendering of inscribed circle (if draws). Possible values are: param: array $circle_outLine_style Line style of inscribed circle (if draws). Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array). param: array $circle_fill_color Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array). |
| StarPolygon($x0, $y0, $r, $nv, $ng, $angle = 0, $draw_circle = false, $style = "", $line_style = array() X-Ref |
| Draws a star polygon param: float $x0 Abscissa of center point. param: float $y0 Ordinate of center point. param: float $r Radius of inscribed circle. param: integer $nv Number of vertices. param: integer $ng Number of gap (if ($ng % $nv = 1) then is a regular polygon). param: float $angle: Angle oriented (anti-clockwise). Default value: 0. param: boolean $draw_circle: Draw inscribed circle or not. Default value is false. param: string $style Style of rendering. Possible values are: param: array $line_style Line style of polygon sides. Array with keys among the following: param: array $fill_color Fill color. Format: array(red, green, blue). Default value: default color (empty array). param: string $circle_style Style of rendering of inscribed circle (if draws). Possible values are: param: array $circle_outLine_style Line style of inscribed circle (if draws). Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array). param: array $circle_fill_color Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array). |
| RoundedRect($x, $y, $w, $h, $r, $round_corner = "1111", $style = "", $border_style = array() X-Ref |
| Draws a rounded rectangle. param: float $x Abscissa of upper-left corner. param: float $y Ordinate of upper-left corner. param: float $w Width. param: float $h Height. param: float $r Radius of the rounded corners. param: string $round_corner 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"). param: string $style Style of rendering. Possible values are: param: array $border_style Border style of rectangle. Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array). param: array $fill_color Fill color. Format: array(red, green, blue). Default value: default color (empty array). |
| utf8StrRev($str, $setbom=false, $forcertl=false) X-Ref |
| Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/). author: Nicola Asuni param: string $str string to manipulate. param: bool $forcertl if 'R' forces RTL, if 'L' forces LTR return: string |
| utf8Bidi($ta, $forcertl=false) X-Ref |
| Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/). author: Nicola Asuni param: array $ta array of characters composing the string. param: bool $forcertl if 'R' forces RTL, if 'L' forces LTR return: string |
| Bookmark($txt, $level=0, $y=-1) X-Ref |
| No description |
| _putbookmarks() X-Ref |
| No description |
| IncludeJS($script) X-Ref |
| No description |
| _putjavascript() X-Ref |
| No description |
| _JScolor($color) X-Ref |
| No description |
| _addfield($type, $name, $x, $y, $w, $h, $prop) X-Ref |
| No description |
| TextField($name, $w, $h, $prop=array() X-Ref |
| No description |
| RadioButton($name, $w, $prop=array() X-Ref |
| No description |
| ListBox($name, $w, $h, $values, $prop=array() X-Ref |
| No description |
| ComboBox($name, $w, $h, $values, $prop=array() X-Ref |
| No description |
| CheckBox($name, $w, $checked=false, $prop=array() X-Ref |
| No description |
| Button($name, $w, $h, $caption, $action, $prop=array() X-Ref |
| No description |
| Generated: Wed Mar 28 15:54:07 2012 | Cross-referenced by PHPXref 0.7.1 |