HTMLPurifier_Printer_ConfigForm Class Reference

Inheritance diagram for HTMLPurifier_Printer_ConfigForm:

Public Member Functions
	__construct ( $name, $doc_url=null, $compress=false)
	prepareGenerator ($config)
	Give generator necessary configuration if possible.
	render ($config, $allowed=true, $render_controls=true)
	Returns HTML output for a configuration form.
	setTextareaDimensions ($cols=null, $rows=null)
	Sets default column and row size for textareas in sub-printers.

Static Public Member Functions
static	getCSS ()
	Retrieves styling, in case it is not accessible by webserver.
static	getJavaScript ()
	Retrieves JavaScript, in case it is not accessible by webserver.

Protected Member Functions
	element ($tag, $contents, $attr=array(), $escape=true)
	Prints a complete element with content inside.
	elementEmpty ($tag, $attr=array())
	end ($tag)
	Returns an end tag.
	escape ($string)
	Escapes a string for HTML output.
	getClass ($obj, $sec_prefix='')
	Retrieves the class of an object without prefixes, as well as metadata.
	listify ($array, $polite=false)
	Takes a list of strings and turns them into a single list.
	renderNamespace ($ns, $directives)
	Renders a single namespace.
	row ($name, $value)
	Prints a simple key/value row in a table.
	start ($tag, $attr=array())
	Main function that renders object or aspect of that object.
	text ($text)

Protected Attributes
	$compress = false
	Whether or not to compress directive names, clipping them off after a certain amount of letters.
	$config
	For easy access.
	$docURL
	Documentation URL, can have fragment tagged on end.
	$fields = array()
	Printers for specific fields.
HTMLPurifier_Config	$genConfig
	$generator
	$name
	Name of form element to stuff config in.

Constructor & Destructor Documentation

__construct()

HTMLPurifier_Printer_ConfigForm::__construct	(		$name,
			$doc_url = null,
			$compress = false )

Parameters

string	$name	Form element name for directives to be stuffed into
string	$doc_url	String documentation URL, will have fragment tagged on
bool	$compress	Integer max length before compressing a directive name, set to false to turn off

Member Function Documentation

element()

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

protectedinherited

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

Return values

string

elementEmpty()

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

protectedinherited

Parameters

string	$tag
array	$attr

Return values

string

end()

HTMLPurifier_Printer::end ( $tag )

protectedinherited

Returns an end tag.

Parameters

string

$tag

Tag name

Return values

string

escape()

HTMLPurifier_Printer::escape ( $string )

protectedinherited

Escapes a string for HTML output.

Parameters

string

$string

String to escape

Return values

string

getClass()

HTMLPurifier_Printer::getClass ( $obj, $sec_prefix = '' )

protectedinherited

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

Return values

string

listify()

HTMLPurifier_Printer::listify ( $array, $polite = false )

protectedinherited

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

Return values

string

prepareGenerator()

HTMLPurifier_Printer::prepareGenerator ( $config )

inherited

Give generator necessary configuration if possible.

Parameters

HTMLPurifier_Config

$config

render()

HTMLPurifier_Printer_ConfigForm::render	(		$config,
			$allowed = true,
			$render_controls = true )

Returns HTML output for a configuration form.

Parameters

HTMLPurifier_Config | array	$config	Configuration object of current form state, or an array where [0] has an HTML namespace and [1] is being rendered.
array | bool	$allowed	Optional namespace(s) and directives to restrict form to.
bool	$render_controls

Return values

string

renderNamespace()

HTMLPurifier_Printer_ConfigForm::renderNamespace ( $ns, $directives )

protected

Renders a single namespace.

Parameters

	$ns	String namespace name
array	$directives	array of directives to values

Return values

string

row()

HTMLPurifier_Printer::row ( $name, $value )

protectedinherited

Prints a simple key/value row in a table.

Parameters

string	$name	Key
mixed	$value	Value

Return values

string

setTextareaDimensions()

HTMLPurifier_Printer_ConfigForm::setTextareaDimensions	(		$cols = null,
			$rows = null )

Sets default column and row size for textareas in sub-printers.

Parameters

$cols	Integer columns of textarea, null to use default
$rows	Integer rows of textarea, null to use default

start()

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

protectedinherited

Main function that renders object or aspect of that object.

Note

Parameters vary depending on printer Returns a start tag

Parameters

string	$tag	Tag name
array	$attr	Attribute array

Return values

string

text()

HTMLPurifier_Printer::text ( $text )

protectedinherited

Parameters

string

$text

Return values

string

Member Data Documentation

$compress

HTMLPurifier_Printer_ConfigForm::$compress = false

protected

Whether or not to compress directive names, clipping them off after a certain amount of letters.

False to disable or integer letters before clipping. @type bool

$config

HTMLPurifier_Printer::$config

protectedinherited

For easy access.

@type HTMLPurifier_Config

$docURL

HTMLPurifier_Printer_ConfigForm::$docURL

protected

Documentation URL, can have fragment tagged on end.

@type string

$fields

HTMLPurifier_Printer_ConfigForm::$fields = array()

protected

Printers for specific fields.

@type HTMLPurifier_Printer[]

$name

HTMLPurifier_Printer_ConfigForm::$name

protected

Name of form element to stuff config in.

@type string

---

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

• lib/htmlpurifier/HTMLPurifier/Printer/ConfigForm.php