Class Dompdf\Dompdf

Dompdf - PHP5 HTML to PDF renderer

Dompdf loads HTML and does its best to render it as a PDF. It gets its name from the new DomDocument PHP5 extension. Source HTML is first parsed by a DomDocument object. Dompdf takes the resulting DOM tree and attaches a {@link Frame} object to each node. {@link Frame} objects store positioning and layout information and each has a reference to a {@link Style} object.

Style information is loaded and parsed (see {@link Stylesheet}) and is applied to the frames in the tree by using XPath. CSS selectors are converted into XPath queries, and the computed {@link Style} objects are applied to the {@link Frame}s.

{@link Frame}s are then decorated (in the design pattern sense of the word) based on their CSS display property ({@link http://www.w3.org/TR/CSS21/visuren.html#propdef-display}). Frame_Decorators augment the basic {@link Frame} class by adding additional properties and methods specific to the particular type of {@link Frame}. For example, in the CSS layout model, block frames (display: block;) contain line boxes that are usually filled with text or other inline frames. The Block therefore adds a $lines property as well as methods to add {@link Frame}s to lines and to add additional lines. {@link Frame}s also are attached to specific AbstractPositioner and {@link AbstractFrameReflower} objects that contain the positioining and layout algorithm for a specific type of frame, respectively. This is an application of the Strategy pattern.

Layout, or reflow, proceeds recursively (post-order) starting at the root of the document. Space constraints (containing block width & height) are pushed down, and resolved positions and sizes bubble up. Thus, every {@link Frame} in the document tree is traversed once (except for tables which use a two-pass layout algorithm). If you are interested in the details, see the reflow() method of the Reflower classes.

Rendering is relatively straightforward once layout is complete. {@link Frame}s are rendered using an adapted {@link Cpdf} class, originally written by Wayne Munro, http://www.ros.co.nz/pdf/. (Some performance related changes have been made to the original {@link Cpdf} class, and the {@link Dompdf\Adapter\CPDF} class provides a simple, stateless interface to PDF generation.) PDFLib support has now also been added, via the {@link Dompdf\Adapter\PDFLib}.

Methods


					
	public

__construct(Options|array|null $options = null)

Class constructor


					
	private

setPhpConfig()

Save the system's existing locale, PCRE JIT, and MBString encoding configuration and configure the system for Dompdf…

Save the system's existing locale, PCRE JIT, and MBString encoding configuration and configure the system for Dompdf processing


					
	private

restorePhpConfig()

Restore the system's locale configuration


					
	public

load_html_file($file)


					
	public

loadHtmlFile(string $file, string $encoding = null)

Loads an HTML file Parse errors are stored in the global array _dompdf_warnings.

Parameters

`$file`	a filename or url to load
`$encoding`	Encoding of $file

Throws

Dompdf\Exception


					
	public

load_html(string $str, string $encoding = null)


					
	public

loadDOM($doc, $quirksmode = false)


					
	public

loadHtml(string $str, string $encoding = null)

Loads an HTML string Parse errors are stored in the global array _dompdf_warnings.

Parameters

`$str`	HTML text to load
`$encoding`	Encoding of $str


					
	public
					static

remove_text_nodes(DOMNode $node)


					
	public
					static

removeTextNodes(DOMNode $node)


					
	private

processHtml()

Builds the {@link FrameTree}, loads any CSS and applies the styles to the {@link FrameTree}


					
	public

enable_caching(string $cacheId)


					
	public

enableCaching(string $cacheId)

Enable experimental caching capability


					
	public

parse_default_view(string $value): bool


					
	public

parseDefaultView(string $value): bool


					
	public

render()

Renders the HTML to PDF


					
	private

writeLog(string $logOutputFile, float $startTime): void

Writes the output buffer in the log file


					
	public

add_info($label, $value)

Add meta information to the PDF after rendering.


					
	public

addInfo(string $label, string $value): void

Add meta information to the PDF after rendering.

Parameters

`$label`	Label of the value (Creator, Producer, etc.)
`$value`	The text to set


					
	public

stream(string $filename = "document.pdf", array $options = [])

Streams the PDF to the client.

The file will open a download dialog by default. The options parameter controls the output. Accepted options (array keys) are:

'compress' = > 1 (=default) or 0: Apply content stream compression

'Attachment' => 1 (=default) or 0: Set the 'Content-Disposition:' HTTP header to 'attachment' (thereby causing the browser to open a download dialog)

Parameters

`$filename`	the name of the streamed file
`$options`	header options (see above)


					
	public

output(array $options = []): string|null

Returns the PDF as a string.

The options parameter controls the output. Accepted options are:

'compress' = > 1 or 0 - apply content stream compression, this is on (1) by default

Parameters

$options

options (see above)


					
	public

output_html(): string


					
	public

outputHtml(): string

Returns the underlying HTML document as a string


					
	public

get_option(string $key): mixed

Get the dompdf option value


					
	public

set_option(string $key, mixed $value): $this


					
	public

set_options(array $options): $this


					
	public

set_paper(string $size, string $orientation = "portrait")


					
	public

setPaper(string|float[] $size, string $orientation = "portrait"): $this

Sets the paper size & orientation

Parameters

`$size`	'letter', 'legal', 'A4', etc. {@link Dompdf\Adapter\CPDF::$PAPER_SIZES}
`$orientation`	'portrait' or 'landscape'


					
	public

getPaperSize(): float[]

Gets the paper size

Returns

A four-element float array


					
	public

getPaperOrientation(): string

Gets the paper orientation

Returns

Either "portrait" or "landscape"


					
	public

setTree(FrameTree $tree): $this


					
	public

get_tree(): FrameTree


					
	public

getTree(): FrameTree

Returns the underlying {@link FrameTree} object


					
	public

set_protocol(string $protocol): $this


					
	public

setProtocol(string $protocol): $this

Sets the protocol to use FIXME validate these


					
	public

get_protocol(): string


					
	public

getProtocol(): string

Returns the protocol in use


					
	public

set_host(string $host)


					
	public

setBaseHost(string $baseHost): $this

Sets the base hostname


					
	public

get_host(): string


					
	public

getBaseHost(): string

Returns the base hostname


					
	public

set_base_path(string $path)

Sets the base path


					
	public

setBasePath(string $basePath): $this

Sets the base path


					
	public

get_base_path(): string


					
	public

getBasePath(): string

Returns the base path


					
	public

set_default_view(string $default_view, array $options): $this

Parameters

`$default_view`	The default document view
`$options`	The view's options


					
	public

setDefaultView(string $defaultView, array $options): $this

Sets the default view

Parameters

`$defaultView`	The default document view
`$options`	The view's options


					
	public

set_http_context(resource $http_context): $this


					
	public

setHttpContext(resource|array $httpContext): $this

Sets the HTTP context


					
	public

get_http_context(): resource


					
	public

getHttpContext(): resource

Returns the HTTP context


					
	public

setCanvas(Canvas $canvas): $this

Set a custom `Canvas` instance to render the document to.

Set a custom Canvas instance to render the document to.

Be aware that the instance will be replaced on render if the document defines a paper size different from the canvas.


					
	public

get_canvas(): Canvas


					
	public

getCanvas(): Canvas

Return the underlying Canvas instance (e.g. Dompdf\Adapter\CPDF, Dompdf\Adapter\GD)


					
	public

setCss(Stylesheet $css): $this


					
	public

get_css(): Stylesheet


					
	public

getCss(): Stylesheet

Returns the stylesheet


					
	public

setDom(DOMDocument $dom): $this


					
	public

get_dom(): DOMDocument


					
	public

getDom(): DOMDocument


					
	public

setOptions(Options $options): $this


					
	public

getOptions(): Options


					
	public

get_callbacks(): array


					
	public

getCallbacks(): array

Returns the callbacks array


					
	public

set_callbacks(array $callbacks): $this

Parameters

$callbacks

the set of callbacks to set


					
	public

setCallbacks(array $callbacks): $this

Define callbacks that allow modifying the document during render.

The callbacks array should contain arrays with event set to a callback event name and f set to a function or any other callable.

The available callback events are:

begin_page_reflow: called before page reflow
begin_frame: called before a frame is rendered
end_frame: called after frame rendering is complete
begin_page_render: called before a page is rendered
end_page_render: called after page rendering is complete
end_document: called for every page after rendering is complete

The function f receives three arguments Frame $frame, Canvas $canvas, and FontMetrics $fontMetrics for all events but end_document. For end_document, the function receives four arguments int $pageNumber, int $pageCount, Canvas $canvas, and FontMetrics $fontMetrics instead.

Parameters

$callbacks

The set of callbacks to set.


					
	public

get_quirksmode(): boolean


					
	public

getQuirksmode(): boolean

Get the quirks mode

Returns

true if quirks mode is active


					
	public

setFontMetrics(FontMetrics $fontMetrics): $this


					
	public

getFontMetrics(): FontMetrics


					
	public

__get(string $prop): mixed

PHP5 overloaded getter Along with {@link Dompdf::__set()} __get() provides access to all properties directly. …

PHP5 overloaded getter Along with {@link Dompdf::__set()} __get() provides access to all properties directly. Typically __get() is not called directly outside of this class.

Throws

Dompdf\Exception

Properties
`private`	`string`	`$version = 'dompdf'`	#
`private`	`DOMDocument`	`$dom`	#
`private`	`FrameTree`	`$tree`	#
`private`	`Stylesheet`	`$css`	#
`private`	`Canvas`	`$canvas`	#
`private`	`string\|float[]`	`$paperSize`	#
`private`	`string`	`$paperOrientation = "portrait"`	#
`private`	`array`	`$callbacks = []`	#
`private`	`string`	`$cacheId`	#
`private`	`string`	`$baseHost = ""`	#
`private`	`string`	`$basePath = ""`	#
`private`	`string`	`$protocol = ""`	#
`private`	`string`	`$systemLocale = null`	#
`private`	`string`	`$mbstringEncoding = null`	#
`private`	`string`	`$pcreJit = null`	#
`private`	`string`	`$defaultView = "Fit"`	#
`private`	`array`	`$defaultViewOptions = []`	#
`private`	`bool`	`$quirksmode = false`	#
`private`	`array`	`$allowedLocalFileExtensions = ["htm", "html"]`	#
`private`	`array`	`$messages = []`	#
`private`	`Options`	`$options`	#
`private`	`FontMetrics`	`$fontMetrics`	#
`public static`	`array`	`$native_fonts = [ "courier", "courier-bold", "courier-oblique", "courier-boldoblique", "helvetica", "helvetica-bold", "helvetica-oblique", "helvetica-boldoblique", "times-roman", "times-bold", "times-italic", "times-bolditalic", "symbol", "zapfdinbats", ]`	#
`public static`	`array`	`$nativeFonts = [ "courier", "courier-bold", "courier-oblique", "courier-boldoblique", "helvetica", "helvetica-bold", "helvetica-oblique", "helvetica-boldoblique", "times-roman", "times-bold", "times-italic", "times-bolditalic", "symbol", "zapfdinbats", ]`	#

Namespaces

Classes

Interfaces

Exceptions

Class Dompdf\Dompdf

Parameters

Throws

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Throws