Docs For Class HTMLPurifier

Description

Located in /library/HTMLPurifier/Printer.php (line 6)

Direct descendents

Class	Description
HTMLPurifier_Printer_CSSDefinition
HTMLPurifier_Printer_HTMLDefinition

Variable Summary

mixed $config

mixed $generator

Method Summary

HTMLPurifier_Printer __construct ()

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

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

void end ($tag $tag)

void escape ($string $string)

void getClass ($obj $obj, [$prefix $sec_prefix = ''])

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

void prepareGenerator ( $config)

void row ($name $name, $value $value)

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

void text ( $text)

Variables

mixed $config (line 17)

Instance of HTMLPurifier_Config, for easy access

access: protected

mixed $generator (line 12)

Instance of HTMLPurifier_Generator for HTML generation convenience funcs

access: protected

Methods

Constructor __construct (line 22)

Initialize $generator.

access: public

HTMLPurifier_Printer __construct ()

element (line 68)

Prints a complete element with content inside

access: protected

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

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

elementEmpty (line 74)

access: protected

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

$tag
$attr

end (line 55)

Returns an end teg

access: protected

void end ($tag $tag)

$tag $tag: Tag name

escape (line 105)

Escapes a string for HTML output.

access: protected

void escape ($string $string)

$string $string: String to escape

getClass (line 134)

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

access: protected

void getClass ($obj $obj, [$prefix $sec_prefix = ''])

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

listify (line 116)

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

access: protected

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

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

prepareGenerator (line 28)

Give generator necessary configuration if possible

access: public

void prepareGenerator ( $config)

$config

row (line 91)

Prints a simple key/value row in a table.

access: protected

void row ($name $name, $value $value)

$name $name: Key
$value $value: Value

start (line 45)

Returns a start tag

access: protected

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

$tag $tag: Tag name
$attr $attr: Attribute array

text (line 80)

access: protected

void text ( $text)

$text

Class HTMLPurifier_Printer