HTMLPurifier_Printer_ConfigForm Class Reference

Inheritance diagram for HTMLPurifier_Printer_ConfigForm:

Collaboration 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)
Static Public Member Functions
static	getCSS ()
static	getJavaScript ()
Protected Member Functions
	renderNamespace ($ns, $directives)
Protected Attributes
	$fields = array()
	$docURL
	$name
	$compress = false

---

Detailed Description

Todo:

Rewrite to use Interchange objects

Definition at line 6 of file ConfigForm.php.

---

Constructor & Destructor Documentation

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

Parameters:

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

Definition at line 36 of file ConfigForm.php.

Here is the call graph for this function:

---

Member Function Documentation

static getCSS

(

)

[static]

Retrieves styling, in case it is not accessible by webserver

Definition at line 61 of file ConfigForm.php.

static getJavaScript

(

)

[static]

Retrieves JavaScript, in case it is not accessible by webserver

Definition at line 68 of file ConfigForm.php.

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

Returns HTML output for a configuration form

Parameters:

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

Definition at line 78 of file ConfigForm.php.

Here is the call graph for this function:

renderNamespace	(	$	ns,
		$	directives
	)		[protected]

Renders a single namespace

Parameters:

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

Definition at line 127 of file ConfigForm.php.

Here is the call graph for this function:

Here is the caller graph for this function:

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 53 of file ConfigForm.php.

---

Field Documentation

$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.

Definition at line 29 of file ConfigForm.php.

$docURL [protected]

Documentation URL, can have fragment tagged on end

Definition at line 17 of file ConfigForm.php.

$fields = array() [protected]

Printers for specific fields

Definition at line 12 of file ConfigForm.php.

$name [protected]

Name of form element to stuff config in

Definition at line 22 of file ConfigForm.php.

---

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

• C:/xampp/htdocs/moodle/lib/htmlpurifier/HTMLPurifier/Printer/ConfigForm.php