Class HtmlToPdfProvider

HtmlToPdf provider for service manager

HtmlToPdfProvider implements Xoops\Core\Service\Contract\HtmlToPdfInterface

Package: HtmlToPdfProvider
Category: ServiceProvider
Copyright: 2013-2014 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Richard Griffith richard@geekwright.com
Since: 2.6.0
Link: http://xoops.org
Located at odules/pdf/class/HtmlToPdfProvider.php

Methods summary
`public`	# `__construct( )` __construct __construct
`protected`	# `resetPdf( )` resetPdf - resets to default state resetPdf - resets to default state
`public`	# `startPdf( Response $response )` startPdf - start a new pdf startPdf - start a new pdf Parameters `$response` \Xoops\Core\Service\Response object Implementation of `Xoops\Core\Service\Contract\HtmlToPdfInterface::startPdf()`
`public string`	# `getName( )` getName - get a short name for this service provider. This should be unique within the scope of the named service, so using module dirname is suggested. getName - get a short name for this service provider. This should be unique within the scope of the named service, so using module dirname is suggested. Returns string a unique name for the service provider
`public string`	# `getDescription( )` getDescription - get human readable description of the service provider getDescription - get human readable description of the service provider Returns string
`public`	# `setPageOrientation( Response $response, string $pageOrientation )` setPageOrientation - set page orientation setPageOrientation - set page orientation Parameters `$response` \Xoops\Core\Service\Response object `$pageOrientation` page orientation, 'P' for portrait, 'L' for landscape Implementation of `Xoops\Core\Service\Contract\HtmlToPdfInterface::setPageOrientation()`
`public`	# `setPageSize( Response $response, string $pageSize )` setPageSize - set standard page size setPageSize - set standard page size Parameters `$response` \Xoops\Core\Service\Response object `$pageSize` standard named page size, i.e. 'LETTER', 'A4', etc. Implementation of `Xoops\Core\Service\Contract\HtmlToPdfInterface::setPageSize()`
`public`	# `setBaseUnit( Response $response, string $unit )` setBaseUnit - set unit of measure for page size, margins, etc. setBaseUnit - set unit of measure for page size, margins, etc. Parameters `$response` \Xoops\Core\Service\Response object `$unit` unit used in page size, margins. Possible values include 'mm' = millimeter, "in" = inches, 'pt' = typographic points Implementation of `Xoops\Core\Service\Contract\HtmlToPdfInterface::setBaseUnit()`
`public`	# `setMargins( Response $response, float $leftMargin, float $topMargin, float $rightMargin, float $bottomMargin )` setMargins - set margin sizes setMargins - set margin sizes Parameters `$response` \Xoops\Core\Service\Response object `$leftMargin` left margin in base units, @see setBaseUnits() `$topMargin` top margin in base units `$rightMargin` right margin in base units `$bottomMargin` bottom margin in base units Returns response->value set to absolute URL to avatar image Implementation of `Xoops\Core\Service\Contract\HtmlToPdfInterface::setMargins()`
`public`	# `setBaseFont( Response $response, string $fontFamily, string $fontStyle = '', float $fontSize = null )` setBaseFont - set the base font used in rendering setBaseFont - set the base font used in rendering Parameters `$response` \Xoops\Core\Service\Response object `$fontFamily` font family `$fontStyle` font style ('bold', 'italic', etc.) `$fontSize` font size in points Implementation of `Xoops\Core\Service\Contract\HtmlToPdfInterface::setBaseFont()`
`public`	# `setDefaultMonospacedFont( Response $response, string $monoFontFamily )` setDefaultMonospacedFont - default monotype font used in rendering setDefaultMonospacedFont - default monotype font used in rendering Parameters `$response` \Xoops\Core\Service\Response object `$monoFontFamily` font family Implementation of `Xoops\Core\Service\Contract\HtmlToPdfInterface::setDefaultMonospacedFont()`
`public`	# `setAuthor( Response $response, string $pdfAuthor )` setAuthor - set author in pdf meta data setAuthor - set author in pdf meta data Parameters `$response` \Xoops\Core\Service\Response object `$pdfAuthor` author name Implementation of `Xoops\Core\Service\Contract\HtmlToPdfInterface::setAuthor()`
`public`	# `setTitle( Response $response, string $pdfTitle )` setTitle - set title in pdf meta data setTitle - set title in pdf meta data Parameters `$response` \Xoops\Core\Service\Response object `$pdfTitle` document title Implementation of `Xoops\Core\Service\Contract\HtmlToPdfInterface::setTitle()`
`public`	# `setSubject( Response $response, string $pdfSubject )` setSubject - set subject in pdf meta data setSubject - set subject in pdf meta data Parameters `$response` \Xoops\Core\Service\Response object `$pdfSubject` document subject Implementation of `Xoops\Core\Service\Contract\HtmlToPdfInterface::setSubject()`
`public`	# `setKeywords( Response $response, string[] $pdfKeywords )` setKeywords - set keywords in pdf meta data setKeywords - set keywords in pdf meta data Parameters `$response` \Xoops\Core\Service\Response object `$pdfKeywords` array of keywords pertaining to document Implementation of `Xoops\Core\Service\Contract\HtmlToPdfInterface::setKeywords()`
`public`	# `addHtml( Response $response, string $html )` addHtml - add HTML formatted text to document. This may be called multiple times addHtml - add HTML formatted text to document. This may be called multiple times Parameters `$response` \Xoops\Core\Service\Response object `$html` HTML formated text to include in document array user info, 'uid', 'uname' and 'email' required Implementation of `Xoops\Core\Service\Contract\HtmlToPdfInterface::addHtml()`
`public`	# `outputPdfInline( Response $response, string $name )` outputPdfInline - output a named pdf document file inline outputPdfInline - output a named pdf document file inline Parameters `$response` \Xoops\Core\Service\Response object `$name` filename for file Implementation of `Xoops\Core\Service\Contract\HtmlToPdfInterface::outputPdfInline()`
`public`	# `outputPdfDownload( Response $response, string $name )` outputPdfDownload - output a named pdf document file for download outputPdfDownload - output a named pdf document file for download Parameters `$response` \Xoops\Core\Service\Response object `$name` filename for file Implementation of `Xoops\Core\Service\Contract\HtmlToPdfInterface::outputPdfDownload()`
`public`	# `fetchPdf( Response $response )` fetchPdf - fetch rendered document as a string fetchPdf - fetch rendered document as a string Parameters `$response` \Xoops\Core\Service\Response object Returns response->value set to string containing document Implementation of `Xoops\Core\Service\Contract\HtmlToPdfInterface::fetchPdf()`

Methods inherited from Xoops\Core\Service\AbstractContract
`getMode(), getPriority(), setPriority()`

Constants inherited from Xoops\Core\Service\Contract\HtmlToPdfInterface
`MODE`

Properties summary
`protected TCPDF`	`$pdfEngine` $pdfEngine $pdfEngine	#
`protected string`	`$pageOrientation` $pageOrientation $pageOrientation	# `'P'`
`protected string`	`$pageSize` $pageSize $pageSize	# `'A4'`
`protected string`	`$unit` $unit $unit	# `'mm'`
`protected float`	`$leftMargin` $leftMargin $leftMargin	#
`protected float`	`$topMargin` $topMargin $topMargin	#
`protected float`	`$rightMargin` $rightMargin $rightMargin	#
`protected float`	`$bottomMargin` $bottomMargin $bottomMargin	#
`protected string`	`$fontFamily` $fontFamily $fontFamily	#
`protected string`	`$fontStyle` $fontStyle $fontStyle	#
`protected float`	`$fontSize` $fontSize $fontSize	#
`protected string`	`$monoFontFamily` $monoFontFamily $monoFontFamily	#
`protected string`	`$pdfAuthor` $pdfAuthor $pdfAuthor	#
`protected string`	`$pdfTitle` $pdfTitle $pdfTitle	#
`protected string`	`$pdfSubject` $pdfSubject $pdfSubject	#
`protected string[]`	`$pdfKeywords` $pdfKeywords $pdfKeywords	#
`protected string`	`$pdfCreator` $pdfCreator $pdfCreator	#
`protected string[]`	`$moduleConfigs` $moduleConfigs $moduleConfigs	#

Properties inherited from Xoops\Core\Service\AbstractContract
`$priority`

Namespaces

Classes

Interfaces

Functions

Class HtmlToPdfProvider

Parameters

Implementation of

Returns

Returns

Parameters

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Parameters

Returns

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Parameters

Returns

Implementation of