HTMLPurifier_Printer Class Reference

Inheritance diagram for HTMLPurifier_Printer:

Collaboration diagram for HTMLPurifier_Printer:

Public Member Functions
	__construct ()
	Initialize $generator. More...
	prepareGenerator ($config)
	Give generator necessary configuration if possible. More...

Protected Member Functions
	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
	$generator
	For HTML generation convenience funcs. More...
	$config
	For easy access. More...

Detailed Description

Definition at line 6 of file Printer.php.

Constructor & Destructor Documentation

__construct()

HTMLPurifier_Printer::__construct

(

)

Initialize $generator.

Definition at line 24 of file Printer.php.

    {
    }

Member Function Documentation

element()

HTMLPurifier_Printer::element (   $tag,   $contents,   $attr = array(),   $escape = true  )

protected

Prints a complete element with content inside.

Parameters

string	$tag	Tag name
string	$contents	Element contents
array	$attr	Tag attributes
bool	$escape	whether or not to escape contents

Returns

string

Definition at line 78 of file Printer.php.

References end(), escape(), and start().

Referenced by HTMLPurifier_Printer_HTMLDefinition\heavyHeader(), HTMLPurifier_Printer_CSSDefinition\render(), HTMLPurifier_Printer_ConfigForm\render(), HTMLPurifier_Printer_ConfigForm_NullDecorator\render(), HTMLPurifier_Printer_ConfigForm_default\render(), HTMLPurifier_Printer_ConfigForm_bool\render(), HTMLPurifier_Printer_HTMLDefinition\renderChildren(), HTMLPurifier_Printer_HTMLDefinition\renderContentSets(), HTMLPurifier_Printer_HTMLDefinition\renderDoctype(), HTMLPurifier_Printer_HTMLDefinition\renderEnvironment(), HTMLPurifier_Printer_HTMLDefinition\renderInfo(), HTMLPurifier_Printer_ConfigForm\renderNamespace(), and row().

    {
        return $this->start($tag, $attr) .
            ($escape ? $this->escape($contents) : $contents) .
            $this->end($tag);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

elementEmpty()

HTMLPurifier_Printer::elementEmpty (   $tag,   $attr = array()  )

protected

Parameters

string	$tag
array	$attr

Returns

string

Definition at line 90 of file Printer.php.

Referenced by HTMLPurifier_Printer_ConfigForm\render(), HTMLPurifier_Printer_ConfigForm_NullDecorator\render(), HTMLPurifier_Printer_ConfigForm_default\render(), and HTMLPurifier_Printer_ConfigForm_bool\render().

    {
        return $this->generator->generateFromToken(
            new HTMLPurifier_Token_Empty($tag, $attr)
        );
    }

Here is the caller graph for this function:

end()

HTMLPurifier_Printer::end (   $tag )

protected

Returns an end tag.

Parameters

string

$tag

Tag name

Returns

string

Definition at line 63 of file Printer.php.

Referenced by element(), HTMLPurifier_Printer_HTMLDefinition\heavyHeader(), HTMLPurifier_Printer_CSSDefinition\render(), HTMLPurifier_Printer_HTMLDefinition\render(), HTMLPurifier_Printer_ConfigForm\render(), HTMLPurifier_Printer_ConfigForm_NullDecorator\render(), HTMLPurifier_Printer_ConfigForm_default\render(), HTMLPurifier_Printer_ConfigForm_bool\render(), HTMLPurifier_Printer_HTMLDefinition\renderChildren(), HTMLPurifier_Printer_HTMLDefinition\renderContentSets(), HTMLPurifier_Printer_HTMLDefinition\renderDoctype(), HTMLPurifier_Printer_HTMLDefinition\renderEnvironment(), HTMLPurifier_Printer_HTMLDefinition\renderInfo(), HTMLPurifier_Printer_ConfigForm\renderNamespace(), and row().

    {
        return $this->generator->generateFromToken(
            new HTMLPurifier_Token_End($tag)
        );
    }

Here is the caller graph for this function:

escape()

HTMLPurifier_Printer::escape (   $string )

protected

Escapes a string for HTML output.

Parameters

string

$string

String to escape

Returns

string

Definition at line 131 of file Printer.php.

References HTMLPurifier_Encoder\cleanUTF8().

Referenced by element(), and HTMLPurifier_Printer_HTMLDefinition\renderChildren().

    {
        $string = HTMLPurifier_Encoder::cleanUTF8($string);
        $string = htmlspecialchars($string, ENT_COMPAT, 'UTF-8');
        return $string;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getClass()

HTMLPurifier_Printer::getClass (   $obj,   $sec_prefix = ''  )

protected

Retrieves the class of an object without prefixes, as well as metadata.

Parameters

object	$obj	Object to determine class of
string	$sec_prefix	Further prefix to remove

Returns

string

Definition at line 170 of file Printer.php.

Referenced by HTMLPurifier_Printer_HTMLDefinition\listifyAttr(), HTMLPurifier_Printer_HTMLDefinition\listifyObjectList(), HTMLPurifier_Printer_CSSDefinition\render(), and HTMLPurifier_Printer_HTMLDefinition\renderEnvironment().

    {
        static $five = null;
        if ($five === null) {
            $five = version_compare(PHP_VERSION, '5', '>=');
        }
        $prefix = 'HTMLPurifier_' . $sec_prefix;
        if (!$five) {
            $prefix = strtolower($prefix);
        }
        $class = str_replace($prefix, '', get_class($obj));
        $lclass = strtolower($class);
        $class .= '(';
        switch ($lclass) {
            case 'enum':
                $values = array();
                foreach ($obj->valid_values as $value => $bool) {
                    $values[] = $value;
                }
                $class .= implode(', ', $values);
                break;
            case 'css_composite':
                $values = array();
                foreach ($obj->defs as $def) {
                    $values[] = $this->getClass($def, $sec_prefix);
                }
                $class .= implode(', ', $values);
                break;
            case 'css_multiple':
                $class .= $this->getClass($obj->single, $sec_prefix) . ', ';
                $class .= $obj->max;
                break;
            case 'css_denyelementdecorator':
                $class .= $this->getClass($obj->def, $sec_prefix) . ', ';
                $class .= $obj->element;
                break;
            case 'css_importantdecorator':
                $class .= $this->getClass($obj->def, $sec_prefix);
                if ($obj->allow) {
                    $class .= ', !important';
                }
                break;
        }
        $class .= ')';
        return $class;
    }

Here is the caller graph for this function:

listify()

HTMLPurifier_Printer::listify (   $array,   $polite = false  )

protected

Takes a list of strings and turns them into a single list.

Parameters

	string[]	$array List of strings
bool	$polite	Bool whether or not to add an end before the last

Returns

string

Definition at line 144 of file Printer.php.

References $ret.

Referenced by HTMLPurifier_Printer_HTMLDefinition\listifyAttr(), HTMLPurifier_Printer_HTMLDefinition\listifyObjectList(), HTMLPurifier_Printer_HTMLDefinition\listifyTagLookup(), HTMLPurifier_Printer_HTMLDefinition\renderEnvironment(), and HTMLPurifier_Printer_HTMLDefinition\renderInfo().

    {
        if (empty($array)) {
            return 'None';
        }
        $ret = '';
        $i = count($array);
        foreach ($array as $value) {
            $i--;
            $ret .= $value;
            if ($i > 0 && !($polite && $i == 1)) {
                $ret .= ', ';
            }
            if ($polite && $i == 1) {
                $ret .= 'and ';
            }
        }
        return $ret;
    }

Here is the caller graph for this function:

prepareGenerator()

HTMLPurifier_Printer::prepareGenerator

(

$config

)

Give generator necessary configuration if possible.

Parameters

HTMLPurifier_Config

$config

Definition at line 32 of file Printer.php.

References $config.

Referenced by HTMLPurifier_Printer_ConfigForm\render(), HTMLPurifier_Printer_ConfigForm_NullDecorator\render(), HTMLPurifier_Printer_ConfigForm_default\render(), and HTMLPurifier_Printer_ConfigForm_bool\render().

    {
        $all = $config->getAll();
        $context = new HTMLPurifier_Context();
        $this->generator = new HTMLPurifier_Generator($config, $context);
    }

Here is the caller graph for this function:

row()

HTMLPurifier_Printer::row (   $name,   $value  )

protected

Prints a simple key/value row in a table.

Parameters

string	$name	Key
mixed	$value	Value

Returns

string

Definition at line 114 of file Printer.php.

References element(), end(), and start().

Referenced by HTMLPurifier_Printer_CSSDefinition\render(), HTMLPurifier_Printer_HTMLDefinition\renderDoctype(), HTMLPurifier_Printer_HTMLDefinition\renderEnvironment(), and HTMLPurifier_Printer_HTMLDefinition\renderInfo().

    {
        if (is_bool($value)) {
            $value = $value ? 'On' : 'Off';
        }
        return
            $this->start('tr') . "\n" .
            $this->element('th', $name) . "\n" .
            $this->element('td', $value) . "\n" .
            $this->end('tr');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

start()

HTMLPurifier_Printer::start (   $tag,   $attr = array()  )

protected

Main function that renders object or aspect of that object.

Note

Parameters vary depending on printer Returns a start tag

Parameters

string	$tag	Tag name
array	$attr	Attribute array

Returns

string

Definition at line 51 of file Printer.php.

Referenced by element(), HTMLPurifier_Printer_HTMLDefinition\heavyHeader(), HTMLPurifier_Printer_CSSDefinition\render(), HTMLPurifier_Printer_HTMLDefinition\render(), HTMLPurifier_Printer_ConfigForm\render(), HTMLPurifier_Printer_ConfigForm_NullDecorator\render(), HTMLPurifier_Printer_ConfigForm_default\render(), HTMLPurifier_Printer_ConfigForm_bool\render(), HTMLPurifier_Printer_HTMLDefinition\renderChildren(), HTMLPurifier_Printer_HTMLDefinition\renderContentSets(), HTMLPurifier_Printer_HTMLDefinition\renderDoctype(), HTMLPurifier_Printer_HTMLDefinition\renderEnvironment(), HTMLPurifier_Printer_HTMLDefinition\renderInfo(), HTMLPurifier_Printer_ConfigForm\renderNamespace(), and row().

    {
        return $this->generator->generateFromToken(
            new HTMLPurifier_Token_Start($tag, $attr ? $attr : array())
        );
    }

Here is the caller graph for this function:

text()

HTMLPurifier_Printer::text (   $text )

protected

Parameters

string

$text

Returns

string

Definition at line 101 of file Printer.php.

References $text.

Referenced by HTMLPurifier_Printer_ConfigForm_NullDecorator\render(), HTMLPurifier_Printer_ConfigForm_default\render(), and HTMLPurifier_Printer_ConfigForm_bool\render().

    {
        return $this->generator->generateFromToken(
            new HTMLPurifier_Token_Text($text)
        );
    }

Here is the caller graph for this function:

Field Documentation

$config

HTMLPurifier_Printer::$config

protected

For easy access.

HTMLPurifier_Config

Definition at line 19 of file Printer.php.

Referenced by prepareGenerator(), HTMLPurifier_Printer_CSSDefinition\render(), HTMLPurifier_Printer_HTMLDefinition\render(), HTMLPurifier_Printer_ConfigForm\render(), HTMLPurifier_Printer_ConfigForm_NullDecorator\render(), HTMLPurifier_Printer_ConfigForm_default\render(), and HTMLPurifier_Printer_ConfigForm_bool\render().

$generator

HTMLPurifier_Printer::$generator

protected

For HTML generation convenience funcs.

HTMLPurifier_Generator

Definition at line 13 of file Printer.php.

---

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

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