Docs For Class jResponseTcpdf

Description

PDF Response based on TCPDF (http://tcpdf.sourceforge.net)

since: 1.0

Located in /core/response/jResponseTcpdf.class.php (line 24)

jResponse
   |
   --jResponseTcpdf

Variable Summary

boolean $doDownload

string $outputFileName

object $tcpdf

string $_type

Method Summary

void initPdf ([string $orientation = 'P'], [string $unit = 'mm'], [mixed $format = 'A4'], [String $encoding = null])

boolean output ()

void outputErrors ()

mixed __call (string $method, array $attr)

Variables

boolean $doDownload = false (line 46)

Says if the "save as" dialog appear or not to the user.

access: public

string $outputFileName = 'document.pdf' (line 40)

name of the file under which the file will be send to the user

access: public

object $tcpdf = null (line 34)

the tcpdf object you want to send.

access: public

string $_type = 'tcpdf' (line 28)

access: protected

Redefinition of:

jResponse::$_type: ident of the response type

Inherited Variables

Inherited from jResponse

jResponse::$_acceptSeveralErrors
jResponse::$_errorMessages
jResponse::$_httpHeaders
jResponse::$_httpHeadersSent
jResponse::$_httpStatusCode
jResponse::$_httpStatusMsg

Methods

initPdf (line 97)

Creates the TCPDF object in $this->fpdf

access: public

void initPdf ([string $orientation = 'P'], [string $unit = 'mm'], [mixed $format = 'A4'], [String $encoding = null])

string $orientation: Orientation (portrait/landscape)
string $unit: Page base unit (default to millimeters)
mixed $format: Page size (defaults to A4)
String $encoding: charset encoding;

output (line 52)

send the PDF to the browser.

return: true if it's ok
access: public

boolean output ()

Redefinition of:

jResponse::output(): Send the response in the correct format.

outputErrors (line 73)

access: public

void outputErrors ()

Redefinition of:

jResponse::outputErrors(): Send a response with only error messages which appears during the action

__call (line 108)

Transmits calls to non-existent methods to TCPDF (max : 8 params because

TCPDF methods never take more than 8 params)

return: Value returned bu FPDF's method
access: public

mixed __call (string $method, array $attr)

string $method: Method name
array $attr: Method parameters

Inherited Methods

Inherited From jResponse

jResponse::__construct()
jResponse::acceptSeveralErrors()
jResponse::addHttpHeader()
jResponse::clearHttpHeaders()
jResponse::getFormatType()
jResponse::getType()
jResponse::hasErrors()
jResponse::output()
jResponse::outputErrors()
jResponse::sendHttpHeaders()
jResponse::setHttpStatus()