DocumentPDF class, provides an easy interface to parse and display a pdf document

• since: 1.5

Located in /joomla/document/pdf/pdf.php (line 25)

 JObject   (Subpackage Base)

 JDocument
   
    JDocumentPDF   (Subpackage Document)

mixed $_engine = null (line 27)

mixed $_header = null (line 31)

mixed $_image_scale = 4 (line 41)

mixed $_margin_bottom = 25 (line 36)

mixed $_margin_footer = 10 (line 34)

mixed $_margin_header = 5 (line 33)

mixed $_margin_left = 15 (line 37)

mixed $_margin_right = 15 (line 38)

mixed $_margin_top = 27 (line 35)

mixed $_name = 'joomla' (line 29)

Inherited Variables

Inherited from JDocument

JDocument::$base
JDocument::$description
JDocument::$direction
JDocument::$language
JDocument::$link
JDocument::$title
JDocument::$_generator

Inherited from JObject

JObject::$_errors

Constructor __construct (line 49)

Class constructore

• access: protected

JDocumentPDF __construct ([array $options = array()])

• array $options: Associative array of options

---

Redefinition of:

JDocument::__construct()

Class constructor

fixLinks (line 243)

void fixLinks ()

getHeader (line 188)

Returns the document header string

• access: public

string getHeader ()

getName (line 167)

Returns the document name

• access: public

string getName ()

render (line 200)

Render the document.

• return: rendered data
• access: public

The render ([boolean $cache = false], [array $params = array()])

• boolean $cache: If true, cache the output
• array $params: Associative array of attributes

---

Redefinition of:

JDocument::render()

Outputs the document

setHeader (line 178)

Sets the document header string

• access: public

void setHeader (string $text)

• string $text: Document header string

setName (line 157)

Sets the document name

• access: public

void setName ([string $name = 'joomla'])

• string $name: Document name

Inherited Methods

Inherited From JDocument

JDocument::__construct()
JDocument::addScript()
JDocument::addScriptDeclaration()
JDocument::addStyleDeclaration()
JDocument::addStyleSheet()
JDocument::getBase()
JDocument::getBuffer()
JDocument::getCharset()
JDocument::getDescription()
JDocument::getDirection()
JDocument::getGenerator()
JDocument::getHeadData()
JDocument::getInstance()
JDocument::getLanguage()
JDocument::getLink()
JDocument::getMetaData()
JDocument::getModifiedDate()
JDocument::getTitle()
JDocument::getType()
JDocument::loadRenderer()
JDocument::render()
JDocument::setBase()
JDocument::setBuffer()
JDocument::setCharset()
JDocument::setDescription()
JDocument::setDirection()
JDocument::setGenerator()
JDocument::setHeadData()
JDocument::setLanguage()
JDocument::setLineEnd()
JDocument::setLink()
JDocument::setMetaData()
JDocument::setMimeEncoding()
JDocument::setModifiedDate()
JDocument::setTab()
JDocument::setTitle()
JDocument::setType()

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::getPublicProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()