oxPDF Class Reference

Inheritance diagram for oxPDF:

[legend]

Collaboration diagram for oxPDF:

[legend]

List of all members.

---

Detailed Description

Including language file Including parent class TCPDF class wrapper, set/overrides oxid specific functionality

Definition at line 189 of file oxpdf.php.

Public Member Functions
	__construct ($orientation='P', $unit='mm', $format='A4', $unicode=true, $encoding='UTF-8', $diskcache=false)
	WriteHTML ($html, $ln=true, $fill=false, $reseth=false, $cell=false, $align='')
	OpenTag ($tag, $attr)
	CloseTag ($tag)
	SetStyle ($tag, $enable)
	PutLink ($URL, $txt)
	Text ($x, $y, $txt, $stroke=0, $clip=false)
	SetFont ($family, $style='', $size=0, $fontfile='')

---

Constructor & Destructor Documentation

oxPDF.__construct	(	$	orientation = 'P',
		$	unit = 'mm',
		$	format = 'A4',
		$	unicode = true,
		$	encoding = 'UTF-8',
		$	diskcache = false
	)

This is the class constructor. It allows to set up the page format, the orientation and the measure unit used in all the methods (except for the font sizes).

Parameters:

	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
	boolean	$diskcache if TRUE reduce the RAM memory usage by caching temporary data on filesystem (slower).

public

Since:

1.0

Definition at line 206 of file oxpdf.php.

---

Member Function Documentation

oxPDF.WriteHTML	(	$	html,
		$	ln = true,
		$	fill = false,
		$	reseth = false,
		$	cell = false,
		$	align = ''
	)

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.

Parameters:

	string	$html html text to print. Default value: empty string.
	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 Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
	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 true).
	float	$cell if true, the cell extends up to the margin.
	string	$align allows to center or align the text. Possible values are: L : left align C : center R : right align '' : empty string : left for LTR or right for RTL

public

Returns:

null MultiCell()

See also:

Multicell(), writeHTML()

Definition at line 232 of file oxpdf.php.

oxPDF.OpenTag	(	$	tag,
		$	attr
	)

Opening tag

Parameters:

	object	$tag tag name
	object	$attr attributes

Returns:

null

Definition at line 273 of file oxpdf.php.

oxPDF.CloseTag

(

$

tag

)

Closing tag

Parameters:

object

$tag tag name

Returns:

null

Definition at line 295 of file oxpdf.php.

oxPDF.SetStyle	(	$	tag,
		$	enable
	)

Modify style and select corresponding font

Parameters:

	object	$tag tag name
	object	$enable enable style

Returns:

null

Definition at line 314 of file oxpdf.php.

oxPDF.PutLink	(	$	URL,
		$	txt
	)

Put a hyperlink

Parameters:

	object	$URL link url
	object	$txt link text

Returns:

null

Definition at line 334 of file oxpdf.php.

oxPDF.Text	(	$	x,
		$	y,
		$	txt,
		$	stroke = 0,
		$	clip = false
	)

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.

Parameters:

	float	$x Abscissa of the origin
	float	$y Ordinate of the origin
	string	$txt String to print
	int	$stroke outline size in points (0 = disable)
	boolean	$clip if true activate clipping mode (you must call StartTransform() before this function and StopTransform() to stop the clipping tranformation).

public

Returns:

null

Since:

1.0

Deprecated:

deprecated since version 4.3.005 (2008-11-25)

See also:

Cell(), Write(), MultiCell(), WriteHTML(), WriteHTMLCell()

Definition at line 360 of file oxpdf.php.

oxPDF.SetFont	(	$	family,
		$	style = '',
		$	size = 0,
		$	fontfile = ''
	)

Sets font for current text line

NOTICE: In case you have problems with fonts, you must override this function and set different font

Parameters:

	string	$family font family
	string	$style font style [optional]
	string	$size font size [optional]
	string	$fontfile font file[optional]

Returns:

null

Definition at line 397 of file oxpdf.php.

---

The documentation for this class was generated from the following file:

• core/oxpdf.php