phpMyAdmin 2.10.3 : Vue détaillée de tcpdf.php

Classe: TCPDF - X-Ref

This is a PHP4 class for generating PDF files on-the-fly without requiring external extensions. 
This class is an extension and improvement of the FPDF class by Olivier Plathey (http://www.fpdf.org). 
This version contains some changes: [porting to PHP4, support for UTF-8 Unicode, code style and formatting, php documentation (www.phpdoc.org), ISO page formats, minor improvements, image scale factor] 
TCPDF project (http://tcpdf.sourceforge.net) is based on the public Domain FPDF class by Olivier Plathey (http://www.fpdf.org). 
To add your own TTF fonts please read /fonts/README.TXT

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

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.

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. 
Example: 
<pre>
class PDF extends TCPDF {
function Footer() {
//Go to 1.5 cm from bottom
$this->SetY(-15);
//Select Arial italic 8
$this->SetFont('Arial','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.

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

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. 
Support UTF-8 Unicode [Nicola Asuni, 2005-01-02]

param: string $s The string whose length is to be computed
return: int

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.

Line($x1, $y1, $x2, $y2) 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

Rect($x, $y, $w, $h, $style='') X-Ref

Outputs a rectangle. It can be drawn (border only), filled (with no border) or both.

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: string $style Style of rendering. Possible values are:<ul><li>D or empty string: draw (default)</li><li>F: fill</li><li>DF or FD: draw and fill</li></ul>

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 FPDF_FONTPATH 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].
Example: 
<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 FPDF_FONTPATH constant</li></ul> 
Example for the last case (note the trailing slash): 
<pre>
define('FPDF_FONTPATH','/home/www/font/');
require('tcpdf.php');

//Times regular 12
$pdf->SetFont('Times');
//Arial bold 14
$pdf->SetFont('Arial','B',14);
//Removes bold
$pdf->SetFont('');
//Times bold, italic and underlined 14
$pdf->SetFont('Times','BIU');
</pre> 
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. 
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
param: float $y Ordinate of the upper-left corner of the rectangle
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(). 
This method is called automatically and should not be called directly by the application. 
Example: 
The method is overriden in an inherited class in order to obtain a 3 column layout: 
<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('Arial','',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='') 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. 
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</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></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().

MultiCell($w, $h, $txt, $border=0, $align='J', $fill=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. 
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 Height of cells.
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.

Write($h, $txt, $link='', $fill=0) X-Ref

This method prints text from the current position. When the right margin is reached (or the \n character is met) a line break occurs and text continues from the left margin. Upon method exit, the current position is left just at the end of the text. It is possible to put a link on the text. 
Example: 
<pre>
//Begin with regular font
$pdf->SetFont('Arial','',14);
$pdf->Write(5,'Visit ');
//Then put a blue underlined link
$pdf->SetTextColor(0,0,255);
$pdf->SetFont('','U');
$pdf->Write(5,'www.tecnick.com','http://www.tecnick.com');
</pre>

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.

Image($file, $x, $y, $w=0, $h=0, $type='', $link='') 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>
but are not supported:<ul><li>Interlacing</li><li>Alpha channel</li></ul>
If a transparent color is defined, it will be taken into account (but will be only interpreted by Acrobat 4 and above). 
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. 

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

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

param: float $x The value of the abscissa.

GetY() X-Ref

Returns the ordinate of the current position.

return: float

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

_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

_parsejpg($file) X-Ref

Extract info from a JPEG file

_parsepng($file) X-Ref

Extract info from a PNG file

_freadint($f) X-Ref

Read a 4-byte integer from file

_textstring($s) X-Ref

Format a text string

_escapetext($s) X-Ref

Format a text string

_escape($s) X-Ref

Add \ before \, ( and )

_putstream($s) X-Ref

_out($s) X-Ref

Add a line to the document

_puttruetypeunicode($font) X-Ref

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

author: Nicola Asuni

UTF8StringToArray($str) X-Ref

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
<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. 
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: string $str string to process.
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) X-Ref

Allows to preserve some HTML formatting. 
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.

writeHTMLCell($w, $h, $x, $y, $html='', $border=0, $ln=0, $fill=0) 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. 
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</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.

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

Poids:	4138 lignes (124 kb)
Inclus ou requis:	2 fois
Référencé:	0 fois
Nécessite:	0 fichiers

Code source de phpMyAdmin 2.10.3

/libraries/tcpdf/ -> tcpdf.php (sommaire)

Définit 1 class

Généré le : Mon Nov 26 15:18:20 2007	par Balluche grâce à PHPXref 0.7