Docs For Class HTMLPurifier

Description

Generates HTML from tokens.

todo: Refactor interface so that configuration/context is determined upon instantiation, no need for messy generateFromTokens() calls
todo: Make some of the more internal functions protected, and have unit tests work around that

Variable Summary

mixed $config

Method Summary

HTMLPurifier_Generator __construct ($config $config, $context $context)

String escape ($string $string, [$quote $quote = null])

Generate generateAttributes ($assoc_array_of_attributes $assoc_array_of_attributes, [$element $element = false])

Generated generateFromToken ($token $token)

Generated generateFromTokens ($tokens $tokens, $config 1)

void generateScriptFromToken ( $token)

Variables

mixed $config (line 3825)

Configuration for the generator

Methods

Constructor __construct (line 3831)

HTMLPurifier_Generator __construct ($config $config, $context $context)

escape (line 3997)

Escapes raw text data.

return: escaped 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.
access: public

String escape ($string $string, [$quote $quote = null])

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

generateAttributes (line 3969)

Generates attribute declarations from attribute array.

Generate generateAttributes ($assoc_array_of_attributes $assoc_array_of_attributes, [$element $element = false])

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

generateFromToken (line 3891)

Generates HTML from a single token.

Generated generateFromToken ($token $token)

generateFromTokens (line 3846)

Generates HTML from an array of tokens.

Generated generateFromTokens ($tokens $tokens, $config 1)

generateScriptFromToken (line 3954)

Special case processor for the contents of script tags

void generateScriptFromToken ( $token)

Class HTMLPurifier_Generator