Class jResponseLatexToPdf

Description

pdf response, generated from a latex content

  • since: 1.0b2

Located in /core/response/jResponseLatexToPdf.class.php (line 18)

jResponse
   |
   --jResponseLatexToPdf
Variable Summary
array $authors
string $bodyTpl
mixed $cachePath
string $date
string $pdflatexPath
string $title
array $_commands
string $_type
Method Summary
jResponseLatexToPdf __construct ()
void addCommand (string $command, string $argument, [array $options = array()])
void clearCache ()
boolean output ()
void outputErrors ()
void _commonProcess ()
Variables
array $authors = array() (line 38)

Authors of the document

  • access: public
jTpl $body = null (line 33)

The template engine used to generate the content

  • access: public
string $bodyTpl = '' (line 28)

selector of the main template file

This template should contains the body content, and is used by the $body template engine

  • access: public
mixed $cachePath = '' (line 68)

path to the cache directory.

default is directory responseLatexToPdf in temp directory

  • since: 1.0
  • access: public
string $date = '\today' (line 49)

Document date

  • since: 1.2
  • access: public
string $outputFileName = 'document.pdf' (line 75)

Document file name

  • since: 1.2
  • access: public
string $pdflatexPath = 'pdflatex' (line 61)

complete path to the pdflatex executable

  • access: public
string $title = '' (line 43)

Document title

  • access: public
array $_commands = array() (line 55)

Contains the list of commands to write in the preamble.

  • access: protected
string $_type = 'ltx2pdf' (line 22)
  • access: protected

Redefinition of:
jResponse::$_type

Inherited Variables

Inherited from jResponse

jResponse::$_acceptSeveralErrors
jResponse::$_httpHeaders
jResponse::$_httpHeadersSent
jResponse::$_httpStatusCode
jResponse::$_httpStatusMsg
Methods
Constructor __construct (line 81)

constructor;

setup the template engine

jResponseLatexToPdf __construct ()

Redefinition of:
jResponse::__construct()
constructor
addCommand (line 93)

Add a command to the preamble, e.g. \documentclass[a4,11pt]{article}

  • access: public
void addCommand (string $command, string $argument, [array $options = array()])
  • string $command: name of the command to add
  • string $argument: argument of the command to add
  • array $options: options of the command to add
addDefaultCommands (line 104)

A list of commands that can be safely used as default, or as a template for the _commonProcess function

Tis function is called if the command stack is empty (useful to get quicly started)

  • access: public
void addDefaultCommands ()
clearCache (line 175)

Clears the cache directory

  • access: public
void clearCache ()
output (line 117)

output the pdf content

  • return: true if the generated content is ok
boolean output ()

Redefinition of:
jResponse::output()
Send the response in the correct format.
outputErrors (line 182)

output errors

  • access: public
void outputErrors ()

Redefinition of:
jResponse::outputErrors()
Send a response with only error messages which appears during the action
_commonProcess (line 168)

The method you can overload in your inherited response

overload it if you want to add processes (additionnal commands, content etc..) for all actions

  • access: protected
void _commonProcess ()

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()

Documentation generated on Thu, 19 Sep 2013 00:06:46 +0200 by phpDocumentor 1.4.3