HTMLPurifier_Printer_ConfigForm Class Reference

Inheritance diagram for HTMLPurifier_Printer_ConfigForm:

Public Member Functions
	__construct ($name, $doc_url=null, $compress=false)
	render ($config, $allowed=true, $render_controls=true)
	setTextareaDimensions ($cols=null, $rows=null)
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
	element ($tag, $contents, $attr=array(), $escape=true)
	elementEmpty ($tag, $attr=array())
	end ($tag)
	escape ($string)
	getClass ($obj, $sec_prefix= '')
	listify ($array, $polite=false)
	row ($name, $value)
	start ($tag, $attr=array())
	text ($text)

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

Detailed Description

Todo:

Rewrite to use Interchange objects

Definition at line 6 of file ConfigForm.php.

Constructor & Destructor Documentation

HTMLPurifier_Printer_ConfigForm::__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.

References $compress, $name, and HTMLPurifier_VarParser\BOOL.

Member Function Documentation

static HTMLPurifier_Printer_ConfigForm::getCSS ( )

static

Retrieves styling, in case it is not accessible by webserver

Definition at line 61 of file ConfigForm.php.

static HTMLPurifier_Printer_ConfigForm::getJavaScript ( )

static

Retrieves JavaScript, in case it is not accessible by webserver

Definition at line 68 of file ConfigForm.php.

HTMLPurifier_Printer_ConfigForm::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.

References $allowed, HTMLPurifier_Printer\$config, $ret, HTMLPurifier_Printer\element(), HTMLPurifier_Printer\elementEmpty(), HTMLPurifier_Printer\end(), HTMLPurifier_Config\getAllowedDirectivesForForm(), HTMLPurifier_Printer\prepareGenerator(), renderNamespace(), and HTMLPurifier_Printer\start().

Here is the call graph for this function:

HTMLPurifier_Printer_ConfigForm::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.

References $ret, $type, $url, HTMLPurifier_Printer\element(), HTMLPurifier_Printer\end(), and HTMLPurifier_Printer\start().

Referenced by render().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Member Data Documentation

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.

Definition at line 29 of file ConfigForm.php.

Referenced by __construct().

HTMLPurifier_Printer_ConfigForm::$docURL

protected

Documentation URL, can have fragment tagged on end

Definition at line 17 of file ConfigForm.php.

HTMLPurifier_Printer_ConfigForm::$fields = array()

protected

Printers for specific fields

Definition at line 12 of file ConfigForm.php.

HTMLPurifier_Printer_ConfigForm::$name

protected

Name of form element to stuff config in

Definition at line 22 of file ConfigForm.php.

Referenced by __construct().

---

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

• L:/0xoops/xoops-2.5.6/htdocs/xoops_lib/modules/protector/library/HTMLPurifier/Printer/ConfigForm.php