HTMLPurifier_Printer Class Reference

Inheritance diagram for HTMLPurifier_Printer:

List of all members.

Public Member Functions
	__construct ()
	Initialize $generator.
	prepareGenerator ($config)
	Give generator necessary configuration if possible.
Protected Member Functions
	start ($tag, $attr=array())
	Main function that renders object or aspect of that object.
	end ($tag)
	Returns an end teg.
	element ($tag, $contents, $attr=array(), $escape=true)
	Prints a complete element with content inside.
	elementEmpty ($tag, $attr=array())
	text ($text)
	row ($name, $value)
	Prints a simple key/value row in a table.
	escape ($string)
	Escapes a string for HTML output.
	listify ($array, $polite=false)
	Takes a list of strings and turns them into a single list.
	getClass ($obj, $sec_prefix= '')
	Retrieves the class of an object without prefixes, as well as metadata.
Protected Attributes
	$generator
	Instance of HTMLPurifier_Generator for HTML generation convenience funcs.
	$config
	Instance of HTMLPurifier_Config, for easy access.

---

Detailed Description

Definition at line 6 of file Printer.php.

---

Constructor & Destructor Documentation

HTMLPurifier_Printer::__construct

(

)

Initialize $generator.

Definition at line 22 of file Printer.php.

Referenced by HTMLPurifier_Printer_ConfigForm_NullDecorator::__construct(), and HTMLPurifier_Printer_ConfigForm::__construct().

---

Member Function Documentation

HTMLPurifier_Printer::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.

References end(), escape(), and start().

Referenced by HTMLPurifier_Printer_HTMLDefinition::heavyHeader(), HTMLPurifier_Printer_ConfigForm_bool::render(), HTMLPurifier_Printer_ConfigForm_default::render(), HTMLPurifier_Printer_ConfigForm_NullDecorator::render(), HTMLPurifier_Printer_ConfigForm::render(), HTMLPurifier_Printer_CSSDefinition::render(), HTMLPurifier_Printer_HTMLDefinition::renderChildren(), HTMLPurifier_Printer_HTMLDefinition::renderContentSets(), HTMLPurifier_Printer_HTMLDefinition::renderDoctype(), HTMLPurifier_Printer_HTMLDefinition::renderEnvironment(), HTMLPurifier_Printer_HTMLDefinition::renderInfo(), HTMLPurifier_Printer_ConfigForm::renderNamespace(), and row().

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

Definition at line 74 of file Printer.php.

Referenced by HTMLPurifier_Printer_ConfigForm_bool::render(), HTMLPurifier_Printer_ConfigForm_default::render(), HTMLPurifier_Printer_ConfigForm_NullDecorator::render(), and HTMLPurifier_Printer_ConfigForm::render().

HTMLPurifier_Printer::end

(

$

tag

)

[protected]

Returns an end teg.

Parameters:

$tag

Tag name

Definition at line 55 of file Printer.php.

Referenced by element(), HTMLPurifier_Printer_HTMLDefinition::heavyHeader(), HTMLPurifier_Printer_ConfigForm_bool::render(), HTMLPurifier_Printer_ConfigForm_default::render(), HTMLPurifier_Printer_ConfigForm_NullDecorator::render(), HTMLPurifier_Printer_ConfigForm::render(), HTMLPurifier_Printer_HTMLDefinition::render(), HTMLPurifier_Printer_CSSDefinition::render(), HTMLPurifier_Printer_HTMLDefinition::renderChildren(), HTMLPurifier_Printer_HTMLDefinition::renderContentSets(), HTMLPurifier_Printer_HTMLDefinition::renderDoctype(), HTMLPurifier_Printer_HTMLDefinition::renderEnvironment(), HTMLPurifier_Printer_HTMLDefinition::renderInfo(), HTMLPurifier_Printer_ConfigForm::renderNamespace(), and row().

HTMLPurifier_Printer::escape

(

$

string

)

[protected]

Escapes a string for HTML output.

Parameters:

$string

String to escape

Definition at line 105 of file Printer.php.

References HTMLPurifier_Encoder::cleanUTF8().

Referenced by element(), and HTMLPurifier_Printer_HTMLDefinition::renderChildren().

HTMLPurifier_Printer::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.

References $def.

Referenced by HTMLPurifier_Printer_HTMLDefinition::listifyAttr(), HTMLPurifier_Printer_HTMLDefinition::listifyObjectList(), HTMLPurifier_Printer_CSSDefinition::render(), and HTMLPurifier_Printer_HTMLDefinition::renderEnvironment().

HTMLPurifier_Printer::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.

Referenced by HTMLPurifier_Printer_HTMLDefinition::listifyAttr(), HTMLPurifier_Printer_HTMLDefinition::listifyObjectList(), HTMLPurifier_Printer_HTMLDefinition::listifyTagLookup(), HTMLPurifier_Printer_HTMLDefinition::renderEnvironment(), and HTMLPurifier_Printer_HTMLDefinition::renderInfo().

HTMLPurifier_Printer::prepareGenerator

(

$

config

)

Give generator necessary configuration if possible.

Definition at line 28 of file Printer.php.

References $config.

Referenced by HTMLPurifier_Printer_ConfigForm_bool::render(), HTMLPurifier_Printer_ConfigForm_default::render(), HTMLPurifier_Printer_ConfigForm_NullDecorator::render(), and HTMLPurifier_Printer_ConfigForm::render().

HTMLPurifier_Printer::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.

References element(), end(), and start().

Referenced by HTMLPurifier_Printer_CSSDefinition::render(), HTMLPurifier_Printer_HTMLDefinition::renderDoctype(), HTMLPurifier_Printer_HTMLDefinition::renderEnvironment(), and HTMLPurifier_Printer_HTMLDefinition::renderInfo().

HTMLPurifier_Printer::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.

Referenced by element(), HTMLPurifier_Printer_HTMLDefinition::heavyHeader(), HTMLPurifier_Printer_ConfigForm_bool::render(), HTMLPurifier_Printer_ConfigForm_default::render(), HTMLPurifier_Printer_ConfigForm_NullDecorator::render(), HTMLPurifier_Printer_ConfigForm::render(), HTMLPurifier_Printer_HTMLDefinition::render(), HTMLPurifier_Printer_CSSDefinition::render(), HTMLPurifier_Printer_HTMLDefinition::renderChildren(), HTMLPurifier_Printer_HTMLDefinition::renderContentSets(), HTMLPurifier_Printer_HTMLDefinition::renderDoctype(), HTMLPurifier_Printer_HTMLDefinition::renderEnvironment(), HTMLPurifier_Printer_HTMLDefinition::renderInfo(), HTMLPurifier_Printer_ConfigForm::renderNamespace(), and row().

HTMLPurifier_Printer::text

(

$

text

)

[protected]

Definition at line 80 of file Printer.php.

Referenced by HTMLPurifier_Printer_ConfigForm_bool::render(), HTMLPurifier_Printer_ConfigForm_default::render(), and HTMLPurifier_Printer_ConfigForm_NullDecorator::render().

---

Member Data Documentation

HTMLPurifier_Printer::$config [protected]

Instance of HTMLPurifier_Config, for easy access.

Definition at line 17 of file Printer.php.

Referenced by prepareGenerator(), HTMLPurifier_Printer_ConfigForm_bool::render(), HTMLPurifier_Printer_ConfigForm_default::render(), HTMLPurifier_Printer_ConfigForm_NullDecorator::render(), HTMLPurifier_Printer_ConfigForm::render(), HTMLPurifier_Printer_HTMLDefinition::render(), and HTMLPurifier_Printer_CSSDefinition::render().

HTMLPurifier_Printer::$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:

• /home/ezyang/Dev/htmlpurifier/library/HTMLPurifier/Printer.php