HTMLPurifier_Printer_ConfigForm_default Class Reference

Swiss-army knife configuration form field printer. More...

Inheritance diagram for HTMLPurifier_Printer_ConfigForm_default:

Collaboration diagram for HTMLPurifier_Printer_ConfigForm_default:

Public Member Functions
	render ($ns, $directive, $value, $name, $config)
Public Member Functions inherited from HTMLPurifier_Printer
	__construct ()
	Initialize $generator. More...
	prepareGenerator ($config)
	Give generator necessary configuration if possible. More...

Data Fields
	$cols = 18
	int More...
	$rows = 5
	int More...

Additional Inherited Members
Protected Member Functions inherited from HTMLPurifier_Printer
	start ($tag, $attr=array())
	Main function that renders object or aspect of that object. More...
	end ($tag)
	Returns an end tag. More...
	element ($tag, $contents, $attr=array(), $escape=true)
	Prints a complete element with content inside. More...
	elementEmpty ($tag, $attr=array())
	text ($text)
	row ($name, $value)
	Prints a simple key/value row in a table. More...
	escape ($string)
	Escapes a string for HTML output. More...
	listify ($array, $polite=false)
	Takes a list of strings and turns them into a single list. More...
	getClass ($obj, $sec_prefix='')
	Retrieves the class of an object without prefixes, as well as metadata. More...
Protected Attributes inherited from HTMLPurifier_Printer
	$generator
	For HTML generation convenience funcs. More...
	$config
	For easy access. More...

Detailed Description

Swiss-army knife configuration form field printer.

Definition at line 278 of file ConfigForm.php.

Member Function Documentation

render()

HTMLPurifier_Printer_ConfigForm_default::render	(		$ns,
			$directive,
			$value,
			$name,
			$config
	)

Parameters

string	$ns
string	$directive
string	$value
string	$name
HTMLPurifier_Config | array	$config

Returns

string

Definition at line 298 of file ConfigForm.php.

References HTMLPurifier_Printer\$config, $ret, HTMLPurifier_VarParser\ALIST, HTMLPurifier_Printer\element(), HTMLPurifier_Printer\elementEmpty(), HTMLPurifier_Printer\end(), HTMLPurifier_VarParser\HASH, HTMLPurifier_VarParser\ITEXT, HTMLPurifier_VarParser\LOOKUP, HTMLPurifier_VarParser\MIXED, HTMLPurifier_Printer\prepareGenerator(), HTMLPurifier_Printer\start(), HTMLPurifier_VarParser\TEXT, and HTMLPurifier_Printer\text().

    {
        if (is_array($config) && isset($config[0])) {
            $gen_config = $config[0];
            $config = $config[1];
        } else {
            $gen_config = $config;
        }
        $this->prepareGenerator($gen_config);
        // this should probably be split up a little
        $ret = '';
        $def = $config->def->info["$ns.$directive"];
        if (is_int($def)) {
            $type = abs($def);
        } else {
            $type = $def->type;
        }
        if (is_array($value)) {
            switch ($type) {
                case HTMLPurifier_VarParser::LOOKUP:
                    $array = $value;
                    $value = array();
                    foreach ($array as $val => $b) {
                        $value[] = $val;
                    }
                    //TODO does this need a break?
                case HTMLPurifier_VarParser::ALIST:
                    $value = implode(PHP_EOL, $value);
                    break;
                case HTMLPurifier_VarParser::HASH:
                    $nvalue = '';
                    foreach ($value as $i => $v) {
                        $nvalue .= "$i:$v" . PHP_EOL;
                    }
                    $value = $nvalue;
                    break;
                default:
                    $value = '';
            }
        }
        if ($type === HTMLPurifier_VarParser::MIXED) {
            return 'Not supported';
            $value = serialize($value);
        }
        $attr = array(
            'name' => "$name" . "[$ns.$directive]",
            'id' => "$name:$ns.$directive"
        );
        if ($value === null) {
            $attr['disabled'] = 'disabled';
        }
        if (isset($def->allowed)) {
            $ret .= $this->start('select', $attr);
            foreach ($def->allowed as $val => $b) {
                $attr = array();
                if ($value == $val) {
                    $attr['selected'] = 'selected';
                }
                $ret .= $this->element('option', $val, $attr);
            }
            $ret .= $this->end('select');
        } elseif ($type === HTMLPurifier_VarParser::TEXT ||
                $type === HTMLPurifier_VarParser::ITEXT ||
                $type === HTMLPurifier_VarParser::ALIST ||
                $type === HTMLPurifier_VarParser::HASH ||
                $type === HTMLPurifier_VarParser::LOOKUP) {
            $attr['cols'] = $this->cols;
            $attr['rows'] = $this->rows;
            $ret .= $this->start('textarea', $attr);
            $ret .= $this->text($value);
            $ret .= $this->end('textarea');
        } else {
            $attr['value'] = $value;
            $attr['type'] = 'text';
            $ret .= $this->elementEmpty('input', $attr);
        }
        return $ret;
    }

Here is the call graph for this function:

Field Documentation

$cols

HTMLPurifier_Printer_ConfigForm_default::$cols = 18

int

Definition at line 283 of file ConfigForm.php.

$rows

HTMLPurifier_Printer_ConfigForm_default::$rows = 5

int

Definition at line 288 of file ConfigForm.php.

---

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

• Services/Html/HtmlPurifier/library/HTMLPurifier/Printer/ConfigForm.php