HTMLPurifier_Printer Class Reference

Inheritance diagram for HTMLPurifier_Printer:

Public Member Functions
	__construct ()
	prepareGenerator ($config)
Protected Member Functions
	start ($tag, $attr=array())
	end ($tag)
	element ($tag, $contents, $attr=array(), $escape=true)
	elementEmpty ($tag, $attr=array())
	text ($text)
	row ($name, $value)
	escape ($string)
	listify ($array, $polite=false)
	getClass ($obj, $sec_prefix= '')
Protected Attributes
	$generator
	$config

---

Detailed Description

Definition at line 6 of file Printer.php.

---

Constructor & Destructor Documentation

__construct

(

)

Initialize $generator.

Definition at line 22 of file Printer.php.

Here is the caller graph for this function:

---

Member Function Documentation

element	(	$	tag,
		$	contents,
		$	attr = array(),
		$	escape = true
	)		[protected]

Prints a complete element with content inside

Parameters:

$tag	Tag name
$contents	Element contents
$attr	Tag attributes
$escape	Bool whether or not to escape contents

Definition at line 68 of file Printer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

elementEmpty	(	$	tag,
		$	attr = array()
	)		[protected]

Definition at line 74 of file Printer.php.

Here is the caller graph for this function:

end

(

$

tag

)

[protected]

Returns an end teg

Parameters:

$tag

Tag name

Definition at line 55 of file Printer.php.

Here is the caller graph for this function:

escape

(

$

string

)

[protected]

Escapes a string for HTML output.

Parameters:

$string

String to escape

Definition at line 105 of file Printer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getClass	(	$	obj,
		$	sec_prefix = ''
	)		[protected]

Retrieves the class of an object without prefixes, as well as metadata

Parameters:

$obj	Object to determine class of
$prefix	Further prefix to remove

Definition at line 134 of file Printer.php.

Here is the caller graph for this function:

listify	(	$	array,
		$	polite = false
	)		[protected]

Takes a list of strings and turns them into a single list

Parameters:

$array	List of strings
$polite	Bool whether or not to add an end before the last

Definition at line 116 of file Printer.php.

Here is the caller graph for this function:

prepareGenerator

(

$

config

)

Give generator necessary configuration if possible

Definition at line 28 of file Printer.php.

Here is the caller graph for this function:

row	(	$	name,
		$	value
	)		[protected]

Prints a simple key/value row in a table.

Parameters:

$name	Key
$value	Value

Definition at line 91 of file Printer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

start	(	$	tag,
		$	attr = array()
	)		[protected]

Main function that renders object or aspect of that object

Note:

Parameters vary depending on printer Returns a start tag

Parameters:

$tag	Tag name
$attr	Attribute array

Definition at line 45 of file Printer.php.

Here is the caller graph for this function:

text

(

$

text

)

[protected]

Definition at line 80 of file Printer.php.

Here is the caller graph for this function:

---

Field Documentation

$config [protected]

Instance of HTMLPurifier_Config, for easy access

Definition at line 17 of file Printer.php.

$generator [protected]

Instance of HTMLPurifier_Generator for HTML generation convenience funcs

Definition at line 12 of file Printer.php.

---

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

• C:/xampp/htdocs/moodle/lib/htmlpurifier/HTMLPurifier/Printer.php