JDocumentPDF Class Reference

Inheritance diagram for JDocumentPDF:

Collaboration diagram for JDocumentPDF:

Public Member Functions
	__construct ($options=array())
	setName ($name= 'joomla')
	getName ()
	setHeader ($text)
	getHeader ()
	render ($cache=false, $params=array())
	fixLinks ()

Public Attributes
	$_engine = null
	$_name = 'joomla'
	$_header = null
	$_header_font = 'courier'
	$_footer_font = 'courier'
	$_margin_header = 5
	$_margin_footer = 10
	$_margin_top = 27
	$_margin_bottom = 25
	$_margin_left = 15
	$_margin_right = 15
	$_image_scale = 4

Constructor & Destructor Documentation

JDocumentPDF::__construct

(

$options = array()

)

Class constructore

protected

Parameters

array

$options

Associative array of options

Member Function Documentation

JDocumentPDF::fixLinks

(

)

JDocumentPDF::getHeader

(

)

Returns the document header string

public

Returns

string

JDocumentPDF::getName

(

)

Returns the document name

public

Returns

string

JDocumentPDF::render	(		$cache = false,
			$params = array()
	)

Render the document.

public

Parameters

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

Returns

The rendered data

JDocumentPDF::setHeader

(

$text

)

Sets the document header string

Parameters

string

$text

Document header string public

Returns

void

JDocumentPDF::setName

(

$name = 'joomla'

)

Sets the document name

Parameters

string

$name

Document name public

Returns

void

Member Data Documentation

JDocumentPDF::$_engine = null

JDocumentPDF::$_footer_font = 'courier'

JDocumentPDF::$_header = null

JDocumentPDF::$_header_font = 'courier'

JDocumentPDF::$_image_scale = 4

JDocumentPDF::$_margin_bottom = 25

JDocumentPDF::$_margin_footer = 10

JDocumentPDF::$_margin_header = 5

JDocumentPDF::$_margin_left = 15

JDocumentPDF::$_margin_right = 15

JDocumentPDF::$_margin_top = 27

JDocumentPDF::$_name = 'joomla'

---

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

• libraries/joomla/document/pdf/pdf.php