\HTMLPurifier_Printer_ConfigForm_default

Swiss-army knife configuration form field printer

Summary

Methods
Properties
Constants
__construct()
prepareGenerator()
render()
$cols
$rows
No constants found
start()
end()
element()
elementEmpty()
text()
row()
escape()
listify()
getClass()
$generator
$config
N/A
No private methods found
No private properties found
N/A

Properties

$cols

$cols

$rows

$rows

$generator

$generator

For HTML generation convenience funcs.

$config

$config

For easy access.

Methods

__construct()

__construct() : mixed

Initialize $generator.

Returns

mixed —

prepareGenerator()

prepareGenerator(\HTMLPurifier_Config  $config) : mixed

Give generator necessary configuration if possible

Parameters

\HTMLPurifier_Config $config

Returns

mixed —

render()

render(string  $ns, string  $directive, string  $value, string  $name, \HTMLPurifier_Config|array  $config) : string

Parameters

string $ns
string $directive
string $value
string $name
\HTMLPurifier_Config|array $config

Returns

string —

start()

start(string  $tag, array  $attr = array()) : string

Returns a start tag

Parameters

string $tag

Tag name

array $attr

Attribute array

Returns

string —

end()

end(string  $tag) : string

Returns an end tag

Parameters

string $tag

Tag name

Returns

string —

element()

element(string  $tag, string  $contents, array  $attr = array(), bool  $escape = true) : string

Prints a complete element with content inside

Parameters

string $tag

Tag name

string $contents

Element contents

array $attr

Tag attributes

bool $escape

whether or not to escape contents

Returns

string —

elementEmpty()

elementEmpty(string  $tag, array  $attr = array()) : string

Parameters

string $tag
array $attr

Returns

string —

text()

text(string  $text) : string

Parameters

string $text

Returns

string —

row()

row(string  $name, mixed  $value) : string

Prints a simple key/value row in a table.

Parameters

string $name

Key

mixed $value

Value

Returns

string —

escape()

escape(string  $string) : string

Escapes a string for HTML output.

Parameters

string $string

String to escape

Returns

string —

listify()

listify(string[]  $array, bool  $polite = false) : string

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

Parameters

string[] $array

List of strings

bool $polite

Bool whether or not to add an end before the last

Returns

string —

getClass()

getClass(object  $obj, string  $sec_prefix = '') : string

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

Parameters

object $obj

Object to determine class of

string $sec_prefix

Further prefix to remove

Returns

string —