Class HTMLPurifier_Printer_ConfigForm

InheritanceHTMLPurifier_Printer_ConfigForm » HTMLPurifier_Printer

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$compress Whether or not to compress directive names, clipping them off after a certain amount of letters. False to disable or integer letters before clipping. HTMLPurifier_Printer_ConfigForm
$config For easy access. HTMLPurifier_Printer
$docURL Documentation URL, can have fragment tagged on end. HTMLPurifier_Printer_ConfigForm
$fields Printers for specific fields. HTMLPurifier_Printer_ConfigForm
$generator For HTML generation convenience funcs. HTMLPurifier_Printer
$name Name of form element to stuff config in. HTMLPurifier_Printer_ConfigForm

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() HTMLPurifier_Printer_ConfigForm
getCSS() Retrieves styling, in case it is not accessible by webserver HTMLPurifier_Printer_ConfigForm
getJavaScript() Retrieves JavaScript, in case it is not accessible by webserver HTMLPurifier_Printer_ConfigForm
prepareGenerator() Give generator necessary configuration if possible HTMLPurifier_Printer
render() Returns HTML output for a configuration form HTMLPurifier_Printer_ConfigForm
setTextareaDimensions() Sets default column and row size for textareas in sub-printers HTMLPurifier_Printer_ConfigForm

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
element() Prints a complete element with content inside HTMLPurifier_Printer
elementEmpty() HTMLPurifier_Printer
end() Returns an end tag HTMLPurifier_Printer
escape() Escapes a string for HTML output. HTMLPurifier_Printer
getClass() Retrieves the class of an object without prefixes, as well as metadata HTMLPurifier_Printer
listify() Takes a list of strings and turns them into a single list HTMLPurifier_Printer
renderNamespace() Renders a single namespace HTMLPurifier_Printer_ConfigForm
row() Prints a simple key/value row in a table. HTMLPurifier_Printer
start() Returns a start tag HTMLPurifier_Printer
text() HTMLPurifier_Printer

Property Details

$compress protected property
protected $compress false
$docURL protected property
protected $docURL null
$fields protected property
protected $fields = []
$name protected property
protected $name null

Method Details

__construct() public method

public void __construct ( $name, $doc_url null, $compress false )
$name string

Form element name for directives to be stuffed into

$doc_url string

String documentation URL, will have fragment tagged on

$compress bool

Integer max length before compressing a directive name, set to false to turn off

getCSS() public static method

Retrieves styling, in case it is not accessible by webserver

public static void getCSS ( )
getJavaScript() public static method

Retrieves JavaScript, in case it is not accessible by webserver

public static void getJavaScript ( )
render() public method

Returns HTML output for a configuration form

public string render ( $config, $allowed true, $render_controls true )
$config HTMLPurifier_Config|array

Configuration object of current form state, or an array

   where [0] has an HTML namespace and [1] is being rendered.
$allowed array|bool

Optional namespace(s) and directives to restrict form to.

$render_controls bool
renderNamespace() protected method

Renders a single namespace

protected string renderNamespace ( $ns, $directives )
$ns

String namespace name

$directives array

Array of directives to values

setTextareaDimensions() public method

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

public void setTextareaDimensions ( $cols null, $rows null )
$cols

Integer columns of textarea, null to use default

$rows

Integer rows of textarea, null to use default