Interface HtmlToPdfInterface

HtmlToPdf service interface

Direct known implementers

Namespace: Xoops\Core\Service\Contract
Package: Xoops\Core
Category: Xoops\Core\Service\Contract\HtmlToPdfInterface
Copyright: 2014 The XOOPS Project https://github.com/XOOPS/XoopsCore
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Richard Griffith richard@geekwright.com
Version: Release: 1.0
Since: 2.6.0
Link: http://xoops.org
Located at oops_lib/Xoops/Core/Service/Contract/HtmlToPdfInterface.php

Methods summary
`public`	# `startPdf( Response $response )` startPdf - start a new pdf startPdf - start a new pdf Parameters `$response` \Xoops\Core\Service\Response object
`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
`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.
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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

Constants summary
`integer`	`MODE`	# `Xoops\Core\Service\Manager::MODE_EXCLUSIVE`

Namespaces

Interfaces

Interface HtmlToPdfInterface

Direct known implementers

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns