HTMLPurifier_Generator Class Reference

Public Member Functions
	__construct ($config, $context)
	escape ($string, $quote=null)
	generateAttributes ($assoc_array_of_attributes, $element=false)
	generateFromToken ($token)
	generateFromTokens ($tokens)
	generateScriptFromToken ($token)

Protected Attributes
	$config

Private Attributes
	$_def
	$_flashCompat
	$_flashStack = array()
	$_innerHTMLFix
	$_scriptFix = false
	$_sortAttr
	$_xhtml = true

Detailed Description

Generates HTML from tokens.

Todo:

Refactor interface so that configuration/context is determined upon instantiation, no need for messy generateFromTokens() calls

Make some of the more internal functions protected, and have unit tests work around that

Definition at line 10 of file Generator.php.

Constructor & Destructor Documentation

HTMLPurifier_Generator::__construct	(		$config,
			$context
	)

Parameters

$config	Instance of HTMLPurifier_Config
$context	Instance of HTMLPurifier_Context

Definition at line 59 of file Generator.php.

References $config.

Member Function Documentation

HTMLPurifier_Generator::escape	(		$string,
			$quote = null
	)

Escapes raw text data.

Todo:

This really ought to be protected, but until we have a facility for properly generating HTML here w/o using tokens, it stays public.

Parameters

$string	String data to escape for HTML.
$quote	Quoting style, like htmlspecialchars. ENT_NOQUOTES is permissible for non-attribute output.

Returns

String escaped data.

Definition at line 245 of file Generator.php.

Referenced by generateAttributes(), and generateFromToken().

Here is the caller graph for this function:

HTMLPurifier_Generator::generateAttributes	(		$assoc_array_of_attributes,
			$element = false
	)

Generates attribute declarations from attribute array.

Note

This does not include the leading or trailing space.

Parameters

$assoc_array_of_attributes	Attribute array
$element	Name of element attributes are for, used to check attribute minimization.

Returns

Generate HTML fragment for insertion.

Definition at line 186 of file Generator.php.

References $html, and escape().

Referenced by generateFromToken().

Here is the call graph for this function:

Here is the caller graph for this function:

HTMLPurifier_Generator::generateFromToken

(

$token

)

Generates HTML from a single token.

Parameters

$token

HTMLPurifier_Token object.

Returns

Generated HTML

Definition at line 120 of file Generator.php.

References $token, escape(), and generateAttributes().

Referenced by generateFromTokens(), and generateScriptFromToken().

Here is the call graph for this function:

Here is the caller graph for this function:

HTMLPurifier_Generator::generateFromTokens

(

$tokens

)

Generates HTML from an array of tokens.

Parameters

$tokens	Array of HTMLPurifier_Token
$config	HTMLPurifier_Config object

Returns

Generated HTML

Definition at line 75 of file Generator.php.

References $html, $i, generateFromToken(), and generateScriptFromToken().

Here is the call graph for this function:

HTMLPurifier_Generator::generateScriptFromToken

(

$token

)

Special case processor for the contents of script tags

Warning

This runs into problems if there's already a literal –> somewhere inside the script contents.

Definition at line 171 of file Generator.php.

References $token, and generateFromToken().

Referenced by generateFromTokens().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

HTMLPurifier_Generator::$_def

private

Cache of HTMLDefinition during HTML output to determine whether or not attributes should be minimized.

Definition at line 27 of file Generator.php.

HTMLPurifier_Generator::$_flashCompat

private

Cache of Output.FlashCompat

Definition at line 37 of file Generator.php.

HTMLPurifier_Generator::$_flashStack = array()

private

Stack for keeping track of object information when outputting IE compatibility code.

Definition at line 48 of file Generator.php.

HTMLPurifier_Generator::$_innerHTMLFix

private

Cache of Output.FixInnerHTML

Definition at line 42 of file Generator.php.

HTMLPurifier_Generator::$_scriptFix = false

private

:HACK: Whether or not generator should comment the insides of <script> tags

Definition at line 21 of file Generator.php.

HTMLPurifier_Generator::$_sortAttr

private

Cache of Output.SortAttr

Definition at line 32 of file Generator.php.

HTMLPurifier_Generator::$_xhtml = true

private

Whether or not generator should produce XML output

Definition at line 16 of file Generator.php.

HTMLPurifier_Generator::$config

protected

Configuration for the generator

Definition at line 53 of file Generator.php.

Referenced by __construct().

---

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

• L:/0xoops/xoops-2.5.6/htdocs/xoops_lib/modules/protector/library/HTMLPurifier/Generator.php