HTMLPurifier_Printer_ConfigForm Class Reference

Inheritance diagram for HTMLPurifier_Printer_ConfigForm:

Public Member Functions
	__construct ( $name, $doc_url=null, $compress=false)
	setTextareaDimensions ($cols=null, $rows=null)
	render ($config, $allowed=true, $render_controls=true)
Public Member Functions inherited from HTMLPurifier_Printer
	__construct ()
	prepareGenerator ($config)

Static Public Member Functions
static	getCSS ()
static	getJavaScript ()

Protected Member Functions
	renderNamespace ($ns, $directives)
Protected Member Functions inherited from HTMLPurifier_Printer
	start ($tag, $attr=array())
	end ($tag)
	element ($tag, $contents, $attr=array(), $escape=true)
	elementEmpty ($tag, $attr=array())
	text ($text)
	row ($name, $value)
	escape ($string)
	listify ($array, $polite=false)
	getClass ($obj, $sec_prefix='')

Protected Attributes
	$fields = array()
	$docURL
	$name
	$compress = false
Protected Attributes inherited from HTMLPurifier_Printer
	$generator
	$config

Detailed Description

Definition at line 6 of file ConfigForm.php.

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

Definition at line 40 of file ConfigForm.php.

Member Function Documentation

getCSS()

static HTMLPurifier_Printer_ConfigForm::getCSS ( )

static

Retrieves styling, in case it is not accessible by webserver

Definition at line 72 of file ConfigForm.php.

getJavaScript()

static HTMLPurifier_Printer_ConfigForm::getJavaScript ( )

static

Retrieves JavaScript, in case it is not accessible by webserver

Definition at line 80 of file ConfigForm.php.

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

Returns

string

Definition at line 93 of file ConfigForm.php.

renderNamespace()

HTMLPurifier_Printer_ConfigForm::renderNamespace (   $ns,   $directives  )

protected

Renders a single namespace

Parameters

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

Returns

string

Definition at line 144 of file ConfigForm.php.

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

Definition at line 59 of file ConfigForm.php.

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

Definition at line 33 of file ConfigForm.php.

$docURL

HTMLPurifier_Printer_ConfigForm::$docURL

protected

Documentation URL, can have fragment tagged on end. @type string

Definition at line 19 of file ConfigForm.php.

$fields

HTMLPurifier_Printer_ConfigForm::$fields = array()

protected

Printers for specific fields. @type HTMLPurifier_Printer[]

Definition at line 13 of file ConfigForm.php.

$name

HTMLPurifier_Printer_ConfigForm::$name

protected

Name of form element to stuff config in. @type string

Definition at line 25 of file ConfigForm.php.

---

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

• plugins/htmlpurifier/standalone/HTMLPurifier/Printer/ConfigForm.php