PHP Class PMA\libraries\PDF

Inheritance: extends TCPD\TCPDF
Show file Open project: phpmyadmin/phpmyadmin Class Usage Examples

Public Properties

Property Type Description
$Alias
$footerset

Public Methods

Method Description
Download ( string $filename ) : void Sends file as a download to user.
Error ( string $error_message = '' ) : void Displays an error message
Footer ( ) : void This function must be named "Footer" to work with the TCPDF library
SetAlias ( string $name, string $value ) : void Function to set alias which will be expanded on page rendering.
__construct ( string $orientation = 'P', string $unit = 'mm', string $format = 'A4', boolean $unicode = true, string $encoding = 'UTF-8', boolean $diskcache = false, boolean $pdfa = false ) Constructs PDF and configures standard parameters.
_putpages ( ) : void Improved with alias expanding.

Method Details

Download() public method

Sends file as a download to user.
public Download ( string $filename ) : void
$filename string file name
return void

Error() public method

Displays an error message
public Error ( string $error_message = '' ) : void
$error_message string the error message
return void

SetAlias() public method

Function to set alias which will be expanded on page rendering.
public SetAlias ( string $name, string $value ) : void
$name string name of the alias
$value string value of the alias
return void

__construct() public method

Constructs PDF and configures standard parameters.
public __construct ( string $orientation = 'P', string $unit = 'mm', string $format = 'A4', boolean $unicode = true, string $encoding = 'UTF-8', boolean $diskcache = false, boolean $pdfa = false )
$orientation string page orientation
$unit string unit
$format string the format used for pages
$unicode boolean true means that the input text is unicode
$encoding string charset encoding; default is UTF-8.
$diskcache boolean if true reduce the RAM memory usage by caching temporary data on filesystem (slower).
$pdfa boolean If TRUE set the document to PDF/A mode.

_putpages() public method

Improved with alias expanding.
public _putpages ( ) : void
return void

Property Details

$Alias public property

public $Alias

$footerset public property

public $footerset