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).
TCPDF
__construct
([string $orientation = 'P'], [string $unit = 'mm'], [mixed $format = 'A4'], [boolean $unicode = true], [String $encoding = "UTF-8"])
-
string
$orientation: page orientation. Possible values are (case insensitive):
- P or Portrait (default)
- L or Landscape
-
string
$unit: User measure unit. Possible values are:
- pt: point
- mm: millimeter (default)
- cm: centimeter
- in: inch
A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit.
-
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).
- 4A0
- 2A0
- A0
- A1
- A2
- A3
- A4 (default)
- A5
- A6
- A7
- A8
- A9
- A10
- B0
- B1
- B2
- B3
- B4
- B5
- B6
- B7
- B8
- B9
- B10
- C0
- C1
- C2
- C3
- C4
- C5
- C6
- C7
- C8
- C9
- C10
- RA0
- RA1
- RA2
- RA3
- RA4
- SRA0
- SRA1
- SRA2
- SRA3
- SRA4
- LETTER
- LEGAL
- EXECUTIVE
- FOLIO
-
boolean
$unicode: TRUE means that the input text is unicode (default = true)
-
String
$encoding: charset encoding; default is UTF-8
Default destructor.
void
__destruct
()
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:
class PDF extends TCPDF {
var $col=0;
public function SetCol($col) {
//Move position to a column
$this->col=$col;
$x=10+$col*65;
$this->SetLeftMargin($x);
$this->SetX($x);
}
public 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();
boolean
AcceptPageBreak
()
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]. Example:
$pdf->AddFont('Comic','I');
// is equivalent to:
$pdf->AddFont('Comic','I','comici.php');
void
AddFont
(string $family, [string $style = ''], [string $file = ''])
-
string
$family: Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font.
-
string
$style: Font style. Possible values are (case insensitive):
- empty string: regular (default)
- B: bold
- I: italic
- BI or IB: bold italic
-
string
$file: The font definition file. By default, the name is built from the family and style, in lower case with no space.
Output anchor link.
void
addHtmlLink
(string $url, string $name, [int $fill = 0])
-
string
$url: link URL
-
string
$name: link name
-
int
$fill: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
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().
void
AddLink
()
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.
void
AddPage
([string $orientation = ''])
-
string
$orientation: Page orientation. Possible values are (case insensitive):
- P or Portrait
- L or Landscape
The default value is the one passed to the constructor.
Defines an alias for the total number of pages. It will be substituted as the document is closed.
Example:
class PDF extends TCPDF {
public 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();
void
AliasNbPages
([string $alias = '{nb}'])
-
string
$alias: The alias. Default value: {nb}.
Converts array of UTF-8 characters to UTF16-BE string.
Based on: http://www.faqs.org/rfcs/rfc2781.html
Encoding UTF-16:
Encoding of a single character from an ISO 10646 character value to
UTF-16 proceeds as follows. Let U be the character number, no greater
than 0x10FFFF.
1) If U < 0x10000, encode U as a 16-bit unsigned integer and
terminate.
2) Let U' = U - 0x10000. Because U is less than or equal to 0x10FFFF,
U' must be less than or equal to 0xFFFFF. That is, U' can be
represented in 20 bits.
3) Initialize two 16-bit unsigned integers, W1 and W2, to 0xD800 and
0xDC00, respectively. These integers each have 10 bits free to
encode the character value, for a total of 20 bits.
4) Assign the 10 high-order bits of the 20-bit U' to the 10 low-order
bits of W1 and the 10 low-order bits of U' to the 10 low-order
bits of W2. Terminate.
Graphically, steps 2 through 4 look like:
U' = yyyyyyyyyyxxxxxxxxxx
W1 = 110110yyyyyyyyyy
W2 = 110111xxxxxxxxxx
string
arrUTF8ToUTF16BE
(array $unicode, [boolean $setbom = true])
-
array
$unicode: array containing UTF-8 unicode values
-
boolean
$setbom: if true set the Byte Order Mark (BOM = 0xFEFF)
void
Bookmark
( $txt, [ $level = 0], [ $y = -1])
void
Button
( $name, $w, $h, $caption, $action, [ $prop = array()])
-
$name
-
$w
-
$h
-
$caption
-
$action
-
$prop
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.
void
Cell
(float $w, [float $h = 0], [string $txt = ''], [mixed $border = 0], [int $ln = 0], [string $align = ''], [int $fill = 0], [mixed $link = ''], [int $stretch = 0])
-
float
$w: Cell width. If 0, the cell extends up to the right margin.
-
float
$h: Cell height. Default value: 0.
-
string
$txt: String to print. Default value: empty string.
-
mixed
$border: Indicates if borders must be drawn around the cell. The value can be either a number:
- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
-
int
$ln: Indicates where the current position should go after the call. Possible values are:
- 0: to the right (or left for RTL languages)
- 1: to the beginning of the next line
- 2: below
-
string
$align: Allows to center or align the text. Possible values are:
- L or empty string: left align (default value)
- C: center
- R: right align
- J: justify
-
int
$fill: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
-
mixed
$link: URL or identifier returned by AddLink().
-
int
$stretch: stretch carachter mode:
- 0 = disabled
- 1 = horizontal scaling only if necessary
- 2 = forced horizontal scaling
- 3 = character spacing only if necessary
- 4 = forced character spacing
void
CheckBox
( $name, $w, [ $checked = false], [ $prop = array()])
Draws a circle.
A circle is formed from n Bezier curves.
void
Circle
(float $x0, float $y0, float $r, [ $astart = 0], [ $afinish = 360], [string $style = ""], [array $line_style = array()], [array $fill_color = array()], [integer $nc = 8], float $astart:, float $afinish:)
-
float
$x0: Abscissa of center point.
-
float
$y0: Ordinate of center point.
-
float
$r: Radius.
-
float
$astart:: Angle start of draw line. Default value: 0.
-
float
$afinish:: Angle finish of draw line. Default value: 360.
-
string
$style: Style of rendering. Possible values are:
- D or empty string: Draw (default).
- F: Fill.
- DF or FD: Draw and fill.
- C: Draw close.
-
array
$line_style: Line style of circle. Array like for SetLineStyle. Default value: default line style (empty array).
-
array
$fill_color: Fill color. Format: array(red, green, blue). Default value: default color (empty array).
-
integer
$nc: Number of curves used in circle. Default value: 8.
-
$astart
-
$afinish
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.
void
Close
()
Process closing tags.
void
closedHTMLTagHandler
(string $tag)
-
string
$tag: tag name (in uppercase)
void
ComboBox
( $name, $w, $h, $values, [ $prop = array()])
-
$name
-
$w
-
$h
-
$values
-
$prop
Returns an associative array (keys: R,G,B) from a hex html code (e.g. #3FE5AA).
array
convertColorHexToDec
([string $color = "#000000"])
-
string
$color: hexadecimal html color [#rrggbb]
Draws a Bezier curve.
The Bezier curve is a tangent to the line between the control points at either end of the curve.
void
Curve
(float $x0, float $y0, float $x1, float $y1, float $x2, float $y2, float $x3, float $y3, [string $style = ""], [array $line_style = array()], [array $fill_color = array()])
-
float
$x0: Abscissa of start point.
-
float
$y0: Ordinate of start point.
-
float
$x1: Abscissa of control point 1.
-
float
$y1: Ordinate of control point 1.
-
float
$x2: Abscissa of control point 2.
-
float
$y2: Ordinate of control point 2.
-
float
$x3: Abscissa of end point.
-
float
$y3: Ordinate of end point.
-
string
$style: Style of rendering. Possible values are:
- D or empty string: Draw (default).
- F: Fill.
- DF or FD: Draw and fill.
-
array
$line_style: Line style of curve. Array like for SetLineStyle. Default value: default line style (empty array).
-
array
$fill_color: Fill color. Format: array(red, green, blue). Default value: default color (empty array).
Draws an ellipse.
An ellipse is formed from n Bezier curves.
void
Ellipse
(float $x0, float $y0, float $rx, [float $ry = 0], [ $angle = 0], [ $astart = 0], [ $afinish = 360], [string $style = ""], [array $line_style = array()], [array $fill_color = array()], [integer $nc = 8], float $angle:, float $astart:, float $afinish:)
-
float
$x0: Abscissa of center point.
-
float
$y0: Ordinate of center point.
-
float
$rx: Horizontal radius.
-
float
$ry: Vertical radius (if ry = 0 then is a circle, see Circle). Default value: 0.
-
float
$angle:: Angle oriented (anti-clockwise). Default value: 0.
-
float
$astart:: Angle start of draw line. Default value: 0.
-
float
$afinish:: Angle finish of draw line. Default value: 360.
-
string
$style: Style of rendering. Possible values are:
- D or empty string: Draw (default).
- F: Fill.
- DF or FD: Draw and fill.
- C: Draw close.
-
array
$line_style: Line style of ellipse. Array like for SetLineStyle. Default value: default line style (empty array).
-
array
$fill_color: Fill color. Format: array(red, green, blue). Default value: default color (empty array).
-
integer
$nc: Number of curves used in ellipse. Default value: 8.
-
$angle
-
$astart
-
$afinish
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
void
Error
(string $msg)
-
string
$msg: The error message
This method is used to render the page footer.
It is automatically called by AddPage() and could be overwritten in your own inherited class.
void
Footer
()
Returns the absolute X value of current position.
float
GetAbsX
()
Returns the page break margin.
int
getBreakMargin
()
Returns the image scale.
float
getImageScale
()
Returns the current the line width.
int
GetLineWidth
()
Returns the numbero of characters in a string.
int
GetNumChars
(string $s)
-
string
$s: The input string.
Get the total number of insered pages.
int
getNumPages
()
Get current document page number.
int
getPage
()
Returns the page height in units.
int
getPageHeight
()
Returns the page width in units.
int
getPageWidth
()
Returns the PDF data.
void
getPDFData
()
Returns the scale factor (number of points in user unit).
int
getScaleFactor
()
Returns the length of a string in user unit. A font must be selected.
Support UTF-8 Unicode [Nicola Asuni, 2005-01-02]
int
GetStringWidth
(string $s)
-
string
$s: The string whose length is to be computed
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.
float
GetX
()
Returns the ordinate of the current position.
float
GetY
()
This method is used to render the page header.
It is automatically called by AddPage() and could be overwritten in your own inherited class.
void
Header
()
Puts an image in the page. The upper-left corner must be given. The dimensions can be specified in different ways:
- explicit width and height (expressed in user unit)
- one explicit dimension, the other being calculated automatically in order to keep the original proportions
- no explicit dimension, in which case the image is put at 72 dpi
Supported formats are JPEG and PNG.
For JPEG, all flavors are allowed:
- gray scales
- true colors (24 bits)
- CMYK (32 bits)
For PNG, are allowed:
- gray scales on at most 8 bits (256 levels)
- indexed colors
- true colors (24 bits)
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.
void
Image
(string $file, float $x, float $y, [float $w = 0], [float $h = 0], [string $type = ''], [mixed $link = ''], [string $align = ''])
-
string
$file: Name of the file containing the image.
-
float
$x: Abscissa of the upper-left corner.
-
float
$y: Ordinate of the upper-left corner.
-
float
$w: Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
-
float
$h: Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
-
string
$type: Image format. Possible values are (case insensitive): JPG, JPEG, PNG. If not specified, the type is inferred from the file extension.
-
mixed
$link: URL or identifier returned by AddLink().
-
string
$align: Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:
- T: top-right for LTR or top-left for RTL
- M: middle-right for LTR or middle-left for RTL
- B: bottom-right for LTR or bottom-left for RTL
- N: next line
void
IncludeJS
( $script)
Justify string by adding space characters.
Justifies string by adding space characters between words. It assumes that words in input string are divided only by single space character.
string
justify
($rowWidth $rowWidth, $txtWidth $txtWidth, $spaceWidth $spaceWidth, $txt $txt)
-
$rowWidth
$rowWidth: float row width in page units (e.g. mm)
-
$txtWidth
$txtWidth: float text string width in page units (e.g. mm)
-
$spaceWidth
$spaceWidth: float space character width in page units (e.g. mm)
-
$txt
$txt: string string to be justified
Reset pointer to the last document page.
void
lastPage
()
Draws a line between two points.
void
Line
(float $x1, float $y1, float $x2, float $y2, [array $style = array()])
-
float
$x1: Abscissa of first point.
-
float
$y1: Ordinate of first point.
-
float
$x2: Abscissa of second point.
-
float
$y2: Ordinate of second point.
-
array
$style: Line style. Array like for SetLineStyle. Default value: default line style (empty array).
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.
void
Link
(float $x, float $y, float $w, float $h, mixed $link)
-
float
$x: Abscissa of the upper-left corner of the rectangle (or upper-right for RTL languages)
-
float
$y: Ordinate of the upper-left corner of the rectangle (or upper-right for RTL languages)
-
float
$w: Width of the rectangle
-
float
$h: Height of the rectangle
-
mixed
$link: URL or identifier returned by AddLink()
Performs a line break. The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.
void
Ln
([float $h = ''])
-
float
$h: The height of the break. By default, the value equals the height of the last printed cell.
Horizontal Mirroring.
void
MirrorH
([int $x = ''])
-
int
$x: abscissa of the point. Default is current x position
Reflection against a straight line through point (x, y) with the gradient angle (angle).
void
MirrorL
([float $angle = 0], [int $x = ''], [int $y = ''])
-
float
$angle: gradient angle of the straight line. Default is 0 (horizontal line).
-
int
$x: abscissa of the point. Default is current x position
-
int
$y: ordinate of the point. Default is current y position
Point reflection mirroring.
void
MirrorP
([int $x = ''], [int $y = ''])
-
int
$x: abscissa of the point. Default is current x position
-
int
$y: ordinate of the point. Default is current y position
Verical Mirroring.
void
MirrorV
([int $y = ''])
-
int
$y: ordinate of the point. Default is current y position
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.
int
MultiCell
(float $w, float $h, string $txt, [mixed $border = 0], [string $align = 'J'], [int $fill = 0], [int $ln = 1])
-
float
$w: Width of cells. If 0, they extend up to the right margin of the page.
-
float
$h: Height of cells.
-
string
$txt: String to print
-
mixed
$border: Indicates if borders must be drawn around the cell block. The value can be either a number:
- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
-
string
$align: Allows to center or align the text. Possible values are:
- L or empty string: left align
- C: center
- R: right align
- J: justification (default value)
-
int
$fill: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
-
int
$ln: Indicates where the current position should go after the call. Possible values are:
- 0: to the right
- 1: to the beginning of the next line [DEFAULT]
- 2: below
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
void
Open
()
Process opening tags.
void
openHTMLTagHandler
(string $tag, string $attr, [int $fill = 0])
-
string
$tag: tag name (in uppercase)
-
string
$attr: tag attribute (in uppercase)
-
int
$fill: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
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.
void
Output
([string $name = ''], [string $dest = ''])
-
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.
-
string
$dest: Destination where to send the document. It can take one of the following values:
- 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.
- D: send to the browser and force a file download with the name given by name.
- F: save to a local file with the name given by name.
- S: return the document as a string. name is ignored.
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).
Get a JPEG filename and return a structure for the PDF creator.
array
outputjpg
(string $filename)
-
string
$filename: JPEG file name.
Returns the current page number.
int
PageNo
()
Converts pixels to millimeters in 72 dpi.
float
pixelsToMillimeters
(int $px)
Draws a polygon.
void
Polygon
(array $p, [string $style = ""], [array $line_style = array()], [array $fill_color = array()])
-
array
$p: Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1))
-
string
$style: Style of rendering. Possible values are:
- D or empty string: Draw (default).
- F: Fill.
- DF or FD: Draw and fill.
-
array
$line_style: Line style of polygon. Array with keys among the following:
- all: Line style of all lines. Array like for SetLineStyle.
- 0 to ($np - 1): Line style of each line. Array like for SetLineStyle.
If a key is not present or is null, not draws the line. Default value is default line style (empty array).
-
array
$fill_color: Fill color. Format: array(red, green, blue). Default value: default color (empty array).
Draws a rectangle.
void
Rect
(float $x, float $y, float $w, float $h, [string $style = ''], [array $border_style = array()], [array $fill_color = array()])
-
float
$x: Abscissa of upper-left corner (or upper-right corner for RTL language).
-
float
$y: Ordinate of upper-left corner (or upper-right corner for RTL language).
-
float
$w: Width.
-
float
$h: Height.
-
string
$style: Style of rendering. Possible values are:
- D or empty string: Draw (default).
- F: Fill.
- DF or FD: Draw and fill.
-
array
$border_style: Border style of rectangle. Array with keys among the following:
- all: Line style of all borders. Array like for SetLineStyle.
- L, T, R, B or combinations: Line style of left, top, right or bottom border. Array like for SetLineStyle.
If a key is not present or is null, not draws the border. Default value: default line style (empty array).
-
array
$fill_color: Fill color. Format: array(red, green, blue). Default value: default color (empty array).
Draws a regular polygon.
void
RegularPolygon
(float $x0, float $y0, $r, integer $ns, [float $angle = 0], [boolean $draw_circle = false], [string $style = ""], [array $line_style = array()], [array $fill_color = array()], [string $circle_style = ""], [array $circle_outLine_style = array()], [array $circle_fill_color = array()], float $r:)
-
float
$x0: Abscissa of center point.
-
float
$y0: Ordinate of center point.
-
float
$r:: Radius of inscribed circle.
-
integer
$ns: Number of sides.
-
float
$angle: Angle oriented (anti-clockwise). Default value: 0.
-
boolean
$draw_circle: Draw inscribed circle or not. Default value: false.
-
string
$style: Style of rendering. Possible values are:
- D or empty string: Draw (default).
- F: Fill.
- DF or FD: Draw and fill.
-
array
$line_style: Line style of polygon sides. Array with keys among the following:
- all: Line style of all sides. Array like for SetLineStyle.
- 0 to ($ns - 1): Line style of each side. Array like for SetLineStyle.
If a key is not present or is null, not draws the side. Default value is default line style (empty array).
-
array
$fill_color: Fill color. Format: array(red, green, blue). Default value: default color (empty array).
-
string
$circle_style: Style of rendering of inscribed circle (if draws). Possible values are:
- D or empty string: Draw (default).
- F: Fill.
- DF or FD: Draw and fill.
-
array
$circle_outLine_style: Line style of inscribed circle (if draws). Array like for SetLineStyle. Default value: default line style (empty array).
-
array
$circle_fill_color: Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array).
-
$r
Rotate object.
void
Rotate
(float $angle, [int $x = ''], [int $y = ''])
-
float
$angle: angle in degrees for counter-clockwise rotation
-
int
$x: abscissa of the rotation center. Default is current x position
-
int
$y: ordinate of the rotation center. Default is current y position
Draws a rounded rectangle.
void
RoundedRect
(float $x, float $y, float $w, float $h, float $r, [string $round_corner = "1111"], [string $style = ""], [array $border_style = array()], [array $fill_color = array()])
-
float
$x: Abscissa of upper-left corner.
-
float
$y: Ordinate of upper-left corner.
-
float
$w: Width.
-
float
$h: Height.
-
float
$r: Radius of the rounded corners.
-
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").
-
string
$style: Style of rendering. Possible values are:
- D or empty string: Draw (default).
- F: Fill.
- DF or FD: Draw and fill.
-
array
$border_style: Border style of rectangle. Array like for SetLineStyle. Default value: default line style (empty array).
-
array
$fill_color: Fill color. Format: array(red, green, blue). Default value: default color (empty array).
Vertical and horizontal non-proportional Scaling.
void
Scale
(float $s_x, float $s_y, [int $x = ''], [int $y = ''])
-
float
$s_x: scaling factor for width as percent. 0 is not allowed.
-
float
$s_y: scaling factor for height as percent. 0 is not allowed.
-
int
$x: abscissa of the scaling center. Default is current x position
-
int
$y: ordinate of the scaling center. Default is current y position
Horizontal Scaling.
void
ScaleX
(float $s_x, [int $x = ''], [int $y = ''])
-
float
$s_x: scaling factor for width as percent. 0 is not allowed.
-
int
$x: abscissa of the scaling center. Default is current x position
-
int
$y: ordinate of the scaling center. Default is current y position
Vertical and horizontal proportional Scaling.
void
ScaleXY
(float $s, [int $x = ''], [int $y = ''])
-
float
$s: scaling factor for width and height as percent. 0 is not allowed.
-
int
$x: abscissa of the scaling center. Default is current x position
-
int
$y: ordinate of the scaling center. Default is current y position
Vertical Scaling.
void
ScaleY
(float $s_y, [int $x = ''], [int $y = ''])
-
float
$s_y: scaling factor for height as percent. 0 is not allowed.
-
int
$x: abscissa of the scaling center. Default is current x position
-
int
$y: ordinate of the scaling center. Default is current y position
Defines the author of the document.
void
SetAuthor
(string $author)
-
string
$author: The name of the author.
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.
void
SetAutoPageBreak
(boolean $auto, [float $margin = 0])
-
boolean
$auto: Boolean indicating if mode should be on or off.
-
float
$margin: Distance from the bottom of the page.
Set document barcode.
void
setBarcode
([string $bc = ""])
Set the internal Cell padding.
void
SetCellPadding
(float $pad)
-
float
$pad: internal padding.
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.
void
SetCompression
(boolean $compress)
-
boolean
$compress: Boolean indicating if compression must be enabled.
Defines the creator of the document. This is typically the name of the application that generates the PDF.
void
SetCreator
(string $creator)
-
string
$creator: The name of the creator.
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.
void
SetDisplayMode
(mixed $zoom, [string $layout = 'continuous'])
-
mixed
$zoom: The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use.
- fullpage: displays the entire page on screen
- fullwidth: uses maximum width of window
- real: uses real size (equivalent to 100% zoom)
- default: uses viewer default mode
-
string
$layout: The page layout. Possible values are:
- single: displays one page at once
- continuous: displays pages continuously (default)
- two: displays two pages on two columns
- default: uses viewer default mode
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.
void
SetDrawColor
(int $r, [int $g = -1], [int $b = -1])
-
int
$r: If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255
-
int
$g: Green component (between 0 and 255)
-
int
$b: Blue component (between 0 and 255)
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.
void
SetFillColor
(int $r, [int $g = -1], [int $b = -1], [boolean $storeprev = false])
-
int
$r: If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255
-
int
$g: Green component (between 0 and 255)
-
int
$b: Blue component (between 0 and 255)
-
boolean
$storeprev: if true stores the RGB array on $prevFillColor variable.
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:
- They are in the current directory (the one where the running script lies)
- They are in one of the directories defined by the include_path parameter
- They are in the directory defined by the K_PATH_FONTS constant
Example for the last case (note the trailing slash):
define('K_PATH_FONTS','/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');
If the file corresponding to the requested font is not found, the error "Could not include font metric file" is generated.
void
SetFont
(string $family, [string $style = ''], [float $size = 0])
-
string
$family: Family font. It can be either a name defined by AddFont() or one of the standard families (case insensitive):
- Courier (fixed-width)
- Helvetica or Arial (synonymous; sans serif)
- Times (serif)
- Symbol (symbolic)
- ZapfDingbats (symbolic)
It is also possible to pass an empty string. In that case, the current family is retained.
-
string
$style: Font style. Possible values are (case insensitive):
- empty string: regular
- B: bold
- I: italic
- U: underline
or any combination. The default value is regular. Bold and italic styles do not apply to Symbol and ZapfDingbats
-
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
Defines the size of the current font.
void
SetFontSize
(float $size)
-
float
$size: The size (in points)
Set footer font.
void
setFooterFont
(array $font)
Set footer margin.
(minimum distance between footer and bottom page margin)
void
setFooterMargin
([int $fm = 10])
-
int
$fm: distance in millimeters
Set header data.
void
setHeaderData
([string $ln = ""], [string $lw = 0], [string $ht = ""], [string $hs = ""])
-
string
$ln: header image logo
-
string
$lw: header image logo width in mm
-
string
$ht: string to print as title on document header
-
string
$hs: string to print on document header
Set header font.
void
setHeaderFont
(array $font)
Set header margin.
(minimum distance between header and top page margin)
void
setHeaderMargin
([int $hm = 10])
-
int
$hm: distance in millimeters
Set the image scale.
void
setImageScale
(float $scale)
-
float
$scale: image scale.
Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
void
SetKeywords
(string $keywords)
-
string
$keywords: The list of keywords.
Set language array.
void
setLanguageArray
(array $language)
Set the last cell height.
void
setLastH
(float $h)
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.
void
SetLeftMargin
(float $margin)
-
float
$margin: The margin.
Set line style.
void
SetLineStyle
(array $style)
-
array
$style: Line style. Array with keys among the following:
- width (float): Width of the line in user units.
- cap (string): Type of cap to put on the line. Possible values are:
butt, round, square. The difference between "square" and "butt" is that
"square" projects a flat end past the end of the line.
- join (string): Type of join. Possible values are: miter, round,
bevel.
- dash (mixed): Dash pattern. Is 0 (without dash) or string with
series of length values, which are the lengths of the on and off dashes.
For example: "2" represents 2 on, 2 off, 2 on, 2 off, ...; "2,1" is 2 on,
1 off, 2 on, 1 off, ...
- phase (integer): Modifier on the dash pattern which is used to shift
the point at which the pattern starts.
- color (array): Draw color. Format: array(red, green, blue).
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.
void
SetLineWidth
(float $width)
Defines the page and position a link points to
void
SetLink
(int $link, [float $y = 0], [int $page = -1])
-
int
$link: The link identifier returned by AddLink()
-
float
$y: Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page)
-
int
$page: Number of target page; -1 indicates the current page. This is the default value
Defines the left, top and right margins. By default, they equal 1 cm. Call this method to change them.
void
SetMargins
(float $left, float $top, [float $right = -1])
-
float
$left: Left margin.
-
float
$top: Top margin.
-
float
$right: Right margin. Default value is the left one.
Move pointer to the apecified document page.
void
setPage
(int $pnum)
Set a flag to print page footer.
void
setPrintFooter
([ $val = true], boolean $value)
-
boolean
$value: set to true to print the page footer (default), false otherwise.
-
$val
Set a flag to print page header.
void
setPrintHeader
([boolean $val = true])
-
boolean
$val: set to true to print the page header (default), false otherwise.
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.
void
SetProtection
([Array $permissions = array()], [String $user_pass = ''], [String $owner_pass = null])
-
Array
$permissions: the set of permissions. Empty by default (only viewing is allowed). (print, modify, copy, annot-forms)
-
String
$user_pass: user password. Empty by default.
-
String
$owner_pass: owner password. If not specified, a random value is used.
Defines the right margin. The method can be called before creating the first page.
void
SetRightMargin
(float $margin)
-
float
$margin: The margin.
Enable or disable Right-To-Left language mode
void
setRTL
(Boolean $enable)
-
Boolean
$enable: if true enable Right-To-Left language mode.
Sets font style.
void
setStyle
(string $tag, boolean $enable)
-
string
$tag: tag name (in lowercase)
-
boolean
$enable
Defines the subject of the document.
void
SetSubject
(string $subject)
-
string
$subject: The subject.
Force temporary RTL language direction
void
setTempRTL
(mixed $mode)
-
mixed
$mode: can be false, 'L' for LTR or 'R' for RTL
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.
void
SetTextColor
(int $r, [int $g = -1], [int $b = -1], [boolean $storeprev = false])
-
int
$r: If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255
-
int
$g: Green component (between 0 and 255)
-
int
$b: Blue component (between 0 and 255)
-
boolean
$storeprev: if true stores the RGB array on $prevTextColor variable.
Defines the title of the document.
void
SetTitle
(string $title)
-
string
$title: The title.
Defines the top margin. The method can be called before creating the first page.
void
SetTopMargin
(float $margin)
-
float
$margin: The margin.
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).
void
SetX
(float $x)
-
float
$x: The value of the abscissa.
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.
void
SetXY
(float $x, float $y)
-
float
$x: The value of the abscissa
-
float
$y: The value of the ordinate
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.
void
SetY
(float $y)
-
float
$y: The value of the ordinate.
Skew.
void
Skew
(float $angle_x, float $angle_y, [int $x = ''], [int $y = ''])
-
float
$angle_x: angle in degrees between -90 (skew to the left) and 90 (skew to the right)
-
float
$angle_y: angle in degrees between -90 (skew to the bottom) and 90 (skew to the top)
-
int
$x: abscissa of the skewing center. default is current x position
-
int
$y: ordinate of the skewing center. default is current y position
Skew horizontally.
void
SkewX
(float $angle_x, [int $x = ''], [int $y = ''])
-
float
$angle_x: angle in degrees between -90 (skew to the left) and 90 (skew to the right)
-
int
$x: abscissa of the skewing center. default is current x position
-
int
$y: ordinate of the skewing center. default is current y position
Skew vertically.
void
SkewY
(float $angle_y, [int $x = ''], [int $y = ''])
-
float
$angle_y: angle in degrees between -90 (skew to the bottom) and 90 (skew to the top)
-
int
$x: abscissa of the skewing center. default is current x position
-
int
$y: ordinate of the skewing center. default is current y position
Draws a star polygon
void
StarPolygon
(float $x0, float $y0, float $r, integer $nv, integer $ng, [ $angle = 0], [ $draw_circle = false], [string $style = ""], [array $line_style = array()], [array $fill_color = array()], [string $circle_style = ""], [array $circle_outLine_style = array()], [array $circle_fill_color = array()], float $angle:, boolean $draw_circle:)
-
float
$x0: Abscissa of center point.
-
float
$y0: Ordinate of center point.
-
float
$r: Radius of inscribed circle.
-
integer
$nv: Number of vertices.
-
integer
$ng: Number of gap (if ($ng % $nv = 1) then is a regular polygon).
-
float
$angle:: Angle oriented (anti-clockwise). Default value: 0.
-
boolean
$draw_circle:: Draw inscribed circle or not. Default value is false.
-
string
$style: Style of rendering. Possible values are:
- D or empty string: Draw (default).
- F: Fill.
- DF or FD: Draw and fill.
-
array
$line_style: Line style of polygon sides. Array with keys among the following:
- all: Line style of all sides. Array like for
SetLineStyle.
- 0 to (n - 1): Line style of each side. Array like for SetLineStyle.
If a key is not present or is null, not draws the side. Default value is default line style (empty array).
-
array
$fill_color: Fill color. Format: array(red, green, blue). Default value: default color (empty array).
-
string
$circle_style: Style of rendering of inscribed circle (if draws). Possible values are:
- D or empty string: Draw (default).
- F: Fill.
- DF or FD: Draw and fill.
-
array
$circle_outLine_style: Line style of inscribed circle (if draws). Array like for SetLineStyle. Default value: default line style (empty array).
-
array
$circle_fill_color: Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array).
-
$angle
-
$draw_circle
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.
void
StartTransform
()
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.
void
StopTransform
()
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.
void
Text
(float $x, float $y, string $txt)
-
float
$x: Abscissa of the origin
-
float
$y: Ordinate of the origin
-
string
$txt: String to print
void
TextField
( $name, $w, $h, [ $prop = array()])
Convert the loaded php image to a JPEG and then return a structure for the PDF creator.
void
toJPEG
(string $file, image $image)
-
string
$file: Image file name.
-
image
$image: Image object. return image JPEG image object.
Apply graphic transformations.
void
Transform
( $tm)
Translate graphic object horizontally and vertically.
void
Translate
(int $t_x, int $t_y)
-
int
$t_x: movement to the right
-
int
$t_y: movement to the bottom
Translate graphic object horizontally.
void
TranslateX
(int $t_x)
-
int
$t_x: movement to the right
Translate graphic object vertically.
void
TranslateY
(int $t_y)
-
int
$t_y: movement to the bottom
Reverse function for htmlentities.
Convert entities in UTF-8.
string
unhtmlentities
($text_to_convert $text_to_convert)
-
$text_to_convert
$text_to_convert: Text to convert.
Converts UTF-8 strings to codepoints array.
Invalid byte sequences will be replaced with 0xFFFD (replacement character)
Based on: http://www.faqs.org/rfcs/rfc3629.html
Char. number range | UTF-8 octet sequence
(hexadecimal) | (binary)
--------------------+-----------------------------------------------
0000 0000-0000 007F | 0xxxxxxx
0000 0080-0000 07FF | 110xxxxx 10xxxxxx
0000 0800-0000 FFFF | 1110xxxx 10xxxxxx 10xxxxxx
0001 0000-0010 FFFF | 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
---------------------------------------------------------------------
ABFN notation:
---------------------------------------------------------------------
UTF8-octets = *( UTF8-char )
UTF8-char = UTF8-1 / UTF8-2 / UTF8-3 / UTF8-4
UTF8-1 = %x00-7F
UTF8-2 = %xC2-DF UTF8-tail
UTF8-3 = %xE0 %xA0-BF UTF8-tail / %xE1-EC 2( UTF8-tail ) /
%xED %x80-9F UTF8-tail / %xEE-EF 2( UTF8-tail )
UTF8-4 = %xF0 %x90-BF 2( UTF8-tail ) / %xF1-F3 3( UTF8-tail ) /
%xF4 %x80-8F 2( UTF8-tail )
UTF8-tail = %x80-BF
---------------------------------------------------------------------
array
UTF8StringToArray
(string $str)
-
string
$str: string to process.
Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
string
utf8StrRev
(string $str, [ $setbom = false], [bool $forcertl = false])
-
string
$str: string to manipulate.
-
bool
$forcertl: if 'R' forces RTL, if 'L' forces LTR
-
$setbom
Converts UTF-8 strings to UTF16-BE.
string
UTF8ToUTF16BE
(string $str, [boolean $setbom = true])
-
string
$str: string to process.
-
boolean
$setbom: if true set the Byte Order Mark (BOM = 0xFEFF)
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:
//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');
void
Write
(float $h, string $txt, [mixed $link = ''], [int $fill = 0])
-
float
$h: Line height
-
string
$txt: String to print
-
mixed
$link: URL or identifier returned by AddLink()
-
int
$fill: Indicates if the background must be painted (1) or transparent (0). Default value: 0.
Print Barcode.
void
writeBarcode
(int $x, int $y, int $w, int $h, string $type, string $style, string $font, int $xres, string $code)
-
int
$x: x position in user units
-
int
$y: y position in user units
-
int
$w: width in user units
-
int
$h: height position in user units
-
string
$type: type of barcode (I25, C128A, C128B, C128C, C39)
-
string
$style: barcode style
-
string
$font: font for text
-
int
$xres: x resolution
-
string
$code: code to print
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
void
writeHTML
(string $html, [boolean $ln = true], [int $fill = 0], [boolean $reseth = false], [boolean $cell = false])
-
string
$html: text to display
-
boolean
$ln: if true add a new line after text (default = true)
-
int
$fill: Indicates if the background must be painted (1) or transparent (0). Default value: 0.
-
boolean
$reseth: if true reset the last cell height (default false).
-
boolean
$cell: if true add the default cMargin space to each Write.
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.
void
writeHTMLCell
(float $w, float $h, float $x, float $y, [string $html = ''], [mixed $border = 0], [int $ln = 0], [int $fill = 0], [boolean $reseth = false])
-
float
$w: Cell width. If 0, the cell extends up to the right margin.
-
float
$h: Cell minimum height. The cell extends automatically if needed.
-
float
$x: upper-left corner X coordinate
-
float
$y: upper-left corner Y coordinate
-
string
$html: html text to print. Default value: empty string.
-
mixed
$border: Indicates if borders must be drawn around the cell. The value can be either a number:
- 0: no border (default)
- 1: frame
or a string containing some or all of the following characters (in any order):- L: left
- T: top
- R: right
- B: bottom
-
int
$ln: Indicates where the current position should go after the call. Possible values are:
- 0: to the right (or left for RTL language)
- 1: to the beginning of the next line
- 2: below
-
int
$fill: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
-
boolean
$reseth: if true reset the last cell height (default false).
void
_addfield
( $type, $name, $x, $y, $w, $h, $prop)
-
$type
-
$name
-
$x
-
$y
-
$w
-
$h
-
$prop
Start document
void
_begindoc
()
_beginpage
void
_beginpage
( $orientation)
Check for locale-related bug
void
_dochecks
()
Underline text
void
_dounderline
(int $x, int $y, string $txt)
-
int
$x: X coordinate
-
int
$y: Y coordinate
-
string
$txt: text to underline
End of page contents
void
_endpage
()
Add \ before \, ( and )
string
_escape
(string $s)
-
string
$s: string to escape.
Format a text string
string
_escapetext
(string $s)
-
string
$s: string to escape.
Read a 4-byte integer from file
4-byte
_freadint
(string $f)
Compute encryption key
void
_generateencryptionkey
(String $user_pass, String $owner_pass, String $protection)
-
String
$user_pass: user password
-
String
$owner_pass: user password
-
String
$protection: protection type
Return fonts path
void
_getfontpath
()
Encrypts a string using MD5 and returns it's value as a binary string.
String
_md5_16
(string $str)
-
string
$str: input string
Begin a new object
void
_newobj
()
Compute encryption key depending on object number where the encrypted data is stored
void
_objectkey
(int $n)
Output a string to the document.
void
_out
(string $s)
-
string
$s: string to output.
void
_outCurve
( $x1, $y1, $x2, $y2, $x3, $y3)
Draws a rectangle.
void
_outRect
(float $x, float $y, float $w, float $h, string $op)
-
float
$x: Abscissa of upper-left corner (or upper-right corner for RTL language).
-
float
$y: Ordinate of upper-left corner (or upper-right corner for RTL language).
-
float
$w: Width.
-
float
$h: Height.
-
string
$op: options
Compute O value (used for RC4 encryption)
String
_Ovalue
(String $user_pass, String $owner_pass)
-
String
$user_pass: user password
-
String
$owner_pass: user password
Extract info from a GIF file
void
_parsegif
( $file)
Extract info from a JPEG file
void
_parsejpg
( $file)
Extract info from a PNG file
void
_parsepng
( $file)
_putcatalog
void
_putcatalog
()
Put encryption on PDF document
void
_putencryption
()
Adds fonts
_putfonts
void
_putfonts
()
_putheader
void
_putheader
()
_putimages
void
_putimages
()
_putinfo
Adds some meta information
void
_putinfo
()
_putpages
void
_putpages
()
_putresourcedict
void
_putresourcedict
()
_putresources
void
_putresources
()
Output a stream.
void
_putstream
(string $s)
-
string
$s: string to output.
_puttrailer
void
_puttrailer
()
Adds unicode fonts.
Based on PDF Reference 1.3 (section 5)
void
_puttruetypeunicode
( $font)
_putxobjectdict
void
_putxobjectdict
()
Returns the input text exrypted using RC4 algorithm and the specified key.
RC4 is the standard encryption algorithm used in PDF format
String
_RC4
(string $key, String $text)
-
string
$key: encryption key
-
String
$text: input text to be encrypted
Format a text string for meta information
string
_textstring
(string $s)
-
string
$s: string to escape.
Format an URI string
string
_uristring
(string $s)
-
string
$s: string to escape.
Compute U value (used for RC4 encryption)
String
_Uvalue
()