Docs For Class HTMLPurifier_Printer

Description

todo: Rewrite to use Interchange objects

Located in /lib/core/Parsers/htmlpurifier/standalone/HTMLPurifier/Printer/ConfigForm.php (line 6)

HTMLPurifier_Printer
   |
   --HTMLPurifier_Printer_ConfigForm

Variable Summary

mixed $compress

mixed $docURL

mixed $fields

mixed $name

Method Summary

static void getCSS ()

static void getJavaScript ()

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

void render ($config $config, [$allowed $allowed = true], [ $render_controls = true])

void renderNamespace ($ns $ns, $directive $directives)

void setTextareaDimensions ([$cols $cols = null], [$rows $rows = null])

Variables

mixed $compress = false (line 29)

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

access: protected

mixed $docURL (line 17)

Documentation URL, can have fragment tagged on end

access: protected

mixed $fields = array() (line 12)

Printers for specific fields

access: protected

mixed $name (line 22)

Name of form element to stuff config in

access: protected

Inherited Variables

Inherited from HTMLPurifier_Printer

HTMLPurifier_Printer::$config
HTMLPurifier_Printer::$generator

Methods

static method getCSS (line 61)

Retrieves styling, in case it is not accessible by webserver

access: public

static void getCSS ()

static method getJavaScript (line 68)

Retrieves JavaScript, in case it is not accessible by webserver

access: public

static void getJavaScript ()

Constructor __construct (line 36)

access: public

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

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

Redefinition of:

HTMLPurifier_Printer::__construct(): Initialize $generator.

render (line 78)

Returns HTML output for a configuration form

access: public

void render ($config $config, [$allowed $allowed = true], [ $render_controls = true])

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

renderNamespace (line 127)

Renders a single namespace

access: protected

void renderNamespace ($ns $ns, $directive $directives)

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

setTextareaDimensions (line 53)

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

access: public

void setTextareaDimensions ([$cols $cols = null], [$rows $rows = null])

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

Inherited Methods

Inherited From HTMLPurifier_Printer

HTMLPurifier_Printer::__construct()
HTMLPurifier_Printer::element()
HTMLPurifier_Printer::elementEmpty()
HTMLPurifier_Printer::end()
HTMLPurifier_Printer::escape()
HTMLPurifier_Printer::getClass()
HTMLPurifier_Printer::listify()
HTMLPurifier_Printer::prepareGenerator()
HTMLPurifier_Printer::row()
HTMLPurifier_Printer::start()
HTMLPurifier_Printer::text()

Class HTMLPurifier_Printer_ConfigForm

Inherited Variables

Inherited Methods