pdf Class Reference

Wrapper class that extends TCPDF (lib/tcpdf/tcpdf.php). More...

Inheritance diagram for pdf:

Public Member Functions
	__construct ($orientation='P', $unit='mm', $format='A4', $unicode=true, $encoding='UTF-8')
	Class constructor.
	get_export_fontlist ()
	Get font list from config.
	get_font_families ()
	Returns list of font families and types of fonts.
	is_core_font_family ($fontfamily)
	Is this font family one of core fonts?
	Output ($name='doc.pdf', $dest='I')
	Send the document to a given destination: string, local file or browser.

Detailed Description

Wrapper class that extends TCPDF (lib/tcpdf/tcpdf.php).

Moodle customisations are done here.

Copyright

Vy-Shane Sin Fat

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

__construct()

pdf::__construct	(		$orientation = 'P',
			$unit = 'mm',
			$format = 'A4',
			$unicode = true,
			$encoding = 'UTF-8' )

Class constructor.

See the parent class documentation for the parameters info.

Member Function Documentation

get_export_fontlist()

pdf::get_export_fontlist

(

)

Get font list from config.

Return values

array|string[]

get_font_families()

pdf::get_font_families

(

)

Returns list of font families and types of fonts.

Return values

array

multidimensional array with font families as keys and B, I, BI and N as values.

is_core_font_family()

pdf::is_core_font_family

(

$fontfamily

)

Is this font family one of core fonts?

Parameters

string

$fontfamily

Return values

bool

Output()

pdf::Output	(		$name = 'doc.pdf',
			$dest = 'I' )

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.

Parameters

$name

(string) The name of the file when saved. Note that special characters are removed and blanks characters are replaced with the underscore character.

$dest

(string) Destination where to send the document. It can take one of the following values: I: send the file inline to the browser (default). 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 server file with the name given by name. S: return the document as a string (name is ignored). FI: equivalent to F + I option FD: equivalent to F + D option E: return the document as base64 mime multi-part email attachment (RFC 2045)

Since

Moodle 1.0

See also

Close()

---

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

• lib/pdflib.php