\HTMLPurifier_Printer_ConfigForm_NullDecorator

Printer decorator for directives that accept null

Summary

Methods

Properties

Constants

__construct()
prepareGenerator()
render()

No public properties found

No constants found

start()
end()
element()
elementEmpty()
text()
row()
escape()
listify()
getClass()

$generator
$config
$obj

N/A

No private methods found

No private properties found

N/A

File: vendor/ezyang/htmlpurifier/library/HTMLPurifier/Printer/ConfigForm.php
Package: Default
Class hierarchy: \HTMLPurifier_Printer

\HTMLPurifier_Printer_ConfigForm_NullDecorator

Tags

None found

Properties

$generator

$generator :

For HTML generation convenience funcs.

Type

Inherited from: \HTMLPurifier_Printer

Tags

type	HTMLPurifier_Generator

$config

$config :

For easy access.

Type

Inherited from: \HTMLPurifier_Printer

Tags

type	HTMLPurifier_Config

$obj

$obj :

Printer being decorated

Type

Tags

type	HTMLPurifier_Printer

Methods

__construct()

__construct(\HTMLPurifier_Printer  $obj)

Initialize $generator.

Parameters

\HTMLPurifier_Printer

$obj

Printer to decorate

prepareGenerator()

prepareGenerator(\HTMLPurifier_Config  $config)

Give generator necessary configuration if possible

Parameters

\HTMLPurifier_Config

$config

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(), boolean  $escape = true) : string

Prints a complete element with content inside

Parameters

string	$tag	Tag name
string	$contents	Element contents
array	$attr	Tag attributes
boolean	$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(array<mixed,string>  $array, boolean  $polite = false) : string

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

Parameters

array<mixed,string>	$array	List of strings
boolean	$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