Xoops\Core\Service\Contract\HtmlToPdfInterface Interface Reference

Inheritance diagram for Xoops\Core\Service\Contract\HtmlToPdfInterface:

Public Member Functions
	addHtml ($response, $html)
	fetchPdf ($response)
	outputPdfDownload ($response, $name)
	outputPdfInline ($response, $name)
	setAuthor ($response, $pdfAuthor)
	setBaseFont ($response, $fontFamily, $fontStyle= '', $fontSize=null)
	setBaseUnit ($response, $unit)
	setDefaultMonospacedFont ($response, $monoFontFamily)
	setKeywords ($response, $pdfKeywords)
	setMargins ($response, $leftMargin, $topMargin, $rightMargin, $bottomMargin)
	setPageOrientation ($response, $pageOrientation)
	setPageSize ($response, $pageSize)
	setSubject ($response, $pdfSubject)
	setTitle ($response, $pdfTitle)
	startPdf ($response)

Public Attributes
const	MODE = \Xoops\Core\Service\Manager::MODE_EXCLUSIVE

Detailed Description

Definition at line 26 of file HtmlToPdfInterface.php.

Member Function Documentation

Xoops\Core\Service\Contract\HtmlToPdfInterface::addHtml	(		$response,
			$html
	)

addHtml - add HTML formatted text to document. This may be called multiple times

Parameters

Response	$response	object
string	$html	HTML formated text to include in document array user info, 'uid', 'uname' and 'email' required

Returns

void

Implemented in HtmlToPdfProvider.

Xoops\Core\Service\Contract\HtmlToPdfInterface::fetchPdf

(

$response

)

fetchPdf - fetch rendered document as a string

Parameters

Response

$response

object

Returns

void - response->value set to string containing document

Implemented in HtmlToPdfProvider.

Xoops\Core\Service\Contract\HtmlToPdfInterface::outputPdfDownload	(		$response,
			$name
	)

outputPdfDownload - output a named pdf document file for download

Parameters

Response	$response	object
string	$name	filename for file

Returns

void

Implemented in HtmlToPdfProvider.

Xoops\Core\Service\Contract\HtmlToPdfInterface::outputPdfInline	(		$response,
			$name
	)

outputPdfInline - output a named pdf document file inline

Parameters

Response	$response	object
string	$name	filename for file

Returns

void

Implemented in HtmlToPdfProvider.

Xoops\Core\Service\Contract\HtmlToPdfInterface::setAuthor	(		$response,
			$pdfAuthor
	)

setAuthor - set author in pdf meta data

Parameters

Response	$response	object
string	$pdfAuthor	author name

Returns

void

Implemented in HtmlToPdfProvider.

Xoops\Core\Service\Contract\HtmlToPdfInterface::setBaseFont	(		$response,
			$fontFamily,
			$fontStyle = '',
			$fontSize = null
	)

setBaseFont - set the base font used in rendering

Parameters

Response	$response	object
string	$fontFamily	font family
string	$fontStyle	font style ('bold', 'italic', etc.)
float	$fontSize	font size in points

Returns

void

Implemented in HtmlToPdfProvider.

Xoops\Core\Service\Contract\HtmlToPdfInterface::setBaseUnit	(		$response,
			$unit
	)

setBaseUnit - set unit of measure for page size, margins, etc.

Parameters

Response	$response	object
string	$unit	unit used in page size, margins. Possible values include 'mm' = millimeter, "in" = inches, 'pt' = typographic points

Returns

void

Implemented in HtmlToPdfProvider.

Xoops\Core\Service\Contract\HtmlToPdfInterface::setDefaultMonospacedFont	(		$response,
			$monoFontFamily
	)

setDefaultMonospacedFont - default monotype font used in rendering

Parameters

Response	$response	object
string	$monoFontFamily	font family

Returns

void

Implemented in HtmlToPdfProvider.

Xoops\Core\Service\Contract\HtmlToPdfInterface::setKeywords	(		$response,
			$pdfKeywords
	)

setKeywords - set keywords in pdf meta data

Parameters

Response	$response	object
	string[]	$pdfKeywords array of keywords pertaining to document

Returns

void

Implemented in HtmlToPdfProvider.

Xoops\Core\Service\Contract\HtmlToPdfInterface::setMargins	(		$response,
			$leftMargin,
			$topMargin,
			$rightMargin,
			$bottomMargin
	)

setMargins - set margin sizes

Parameters

Response	$response	object
float	$leftMargin	left margin in base units,

See also

setBaseUnits()

Parameters

float	$topMargin	top margin in base units
float	$rightMargin	right margin in base units
float	$bottomMargin	bottom margin in base units

Returns

void - response->value set to absolute URL to avatar image

Implemented in HtmlToPdfProvider.

Xoops\Core\Service\Contract\HtmlToPdfInterface::setPageOrientation	(		$response,
			$pageOrientation
	)

setPageOrientation - set page orientation

Parameters

Response	$response	object
string	$pageOrientation	page orientation, 'P' for portrait, 'L' for landscape

Returns

void

Implemented in HtmlToPdfProvider.

Xoops\Core\Service\Contract\HtmlToPdfInterface::setPageSize	(		$response,
			$pageSize
	)

setPageSize - set standard page size

Parameters

Response	$response	object
string	$pageSize	standard named page size, i.e. 'LETTER', 'A4', etc.

Returns

void

Implemented in HtmlToPdfProvider.

Xoops\Core\Service\Contract\HtmlToPdfInterface::setSubject	(		$response,
			$pdfSubject
	)

setSubject - set subject in pdf meta data

Parameters

Response	$response	object
string	$pdfSubject	document subject

Returns

void

Implemented in HtmlToPdfProvider.

Xoops\Core\Service\Contract\HtmlToPdfInterface::setTitle	(		$response,
			$pdfTitle
	)

setTitle - set title in pdf meta data

Parameters

Response	$response	object
string	$pdfTitle	document title

Returns

void

Implemented in HtmlToPdfProvider.

Xoops\Core\Service\Contract\HtmlToPdfInterface::startPdf

(

$response

)

startPdf - start a new pdf

Parameters

Response

$response

object

Returns

void

Implemented in HtmlToPdfProvider.

Member Data Documentation

const Xoops\Core\Service\Contract\HtmlToPdfInterface::MODE = \Xoops\Core\Service\Manager::MODE_EXCLUSIVE

Definition at line 28 of file HtmlToPdfInterface.php.

---

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

• C:/usr64/htdocs/xoops_lib/Xoops/Core/Service/Contract/HtmlToPdfInterface.php