Referência à classe DOMPDF

Membros públicos
	__construct ()
	get_tree ()
	set_protocol ($proto)
	set_host ($host)
	set_base_path ($path)
	get_protocol ()
	get_host ()
	get_base_path ()
	get_canvas ()
	load_html_file ($file)
	load_html ($str)
	set_paper ($size, $orientation="portrait")
	enable_caching ($cache_id)
	render ()
	stream ($filename, $options=null)
	output ()

Membros protegidos
	_process_html ()

Atributos Protegidos
	$_xml
	$_tree
	$_css
	$_pdf
	$_paper_size
	$_paper_orientation
	$_base_host
	$_base_path
	$_protocol

Documentação dos Construtores & Destrutor

__construct()

__construct

(

)

Class constructor

Documentação das funções

_process_html()

_process_html ( )

protected

Builds the Frame_Tree, loads any CSS and applies the styles to the Frame_Tree

enable_caching()

enable_caching

(

$cache_id

)

Enable experimental caching capability @access private

get_base_path()

get_base_path

(

)

Returns the base path

Retorna

string

get_canvas()

get_canvas

(

)

Return the underlying Canvas instance (e.g. CPDF_Adapter, GD_Adapter)

Retorna

Canvas

get_host()

get_host

(

)

Returns the base hostname

Retorna

string

get_protocol()

get_protocol

(

)

Returns the protocol in use

Retorna

string

get_tree()

get_tree

(

)

Returns the underlying Frame_Tree object

Retorna

Frame_Tree

load_html()

load_html

(

$str

)

Loads an HTML string

Parse errors are stored in the global array _dompdf_warnings.

Parâmetros

string

$str

HTML text to load

load_html_file()

load_html_file

(

$file

)

Loads an HTML file

Parse errors are stored in the global array _dompdf_warnings.

Parâmetros

string

$file

a filename or url to load

output()

output

(

)

Returns the PDF as a string

Retorna

string

render()

render

(

)

Renders the HTML to PDF

set_base_path()

set_base_path

(

$path

)

Sets the base path

Parâmetros

string

$path

set_host()

set_host

(

$host

)

Sets the base hostname

Parâmetros

string

$host

set_paper()

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

Sets the paper size & orientation

Parâmetros

string	$size	'letter', 'legal', 'A4', etc. CPDF_Adapter::$PAPER_SIZES
string	$orientation	'portrait' or 'landscape'

set_protocol()

set_protocol

(

$proto

)

Sets the protocol to use

Parâmetros

string

$proto

stream()

stream	(		$filename,
			$options = null )

Streams the PDF to the client

The file will open a download dialog by default. The options parameter controls the output headers. Accepted headers are:

'Accept-Ranges' => 1 or 0 - if this is not set to 1, then this header is not included, off by default this header seems to have caused some problems despite tha fact that it is supposed to solve them, so I am leaving it off by default.

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

'Attachment' => 1 or 0 - if 1, force the browser to open a download dialog, on (1) by default

Parâmetros

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

Documentação dos campos e atributos

$_base_host

$_base_host

protected

$_base_path

$_base_path

protected

$_css

$_css

protected

$_paper_orientation

$_paper_orientation

protected

$_paper_size

$_paper_size

protected

$_pdf

$_pdf

protected

$_protocol

$_protocol

protected

$_tree

$_tree

protected

$_xml

$_xml

protected

---

A documentação para esta classe foi gerada a partir do seguinte ficheiro:

• /var/docker/solisge-devel/www/solisge/miolo25/classes/extensions/dompdf/include/dompdf.cls.php