HTMLPurifier_ContentSets Class Reference

Collaboration diagram for HTMLPurifier_ContentSets:

Public Member Functions
	__construct ($modules)
	Merges in module's content sets, expands identifiers in the content sets and populates the keys, values and lookup member variables. More...
	generateChildDef (&$def, $module)
	Accepts a definition; generates and assigns a ChildDef for it. More...
	generateChildDefCallback ($matches)
	getChildDef ($def, $module)
	Instantiates a ChildDef based on content_model and content_model_type member variables in HTMLPurifier_ElementDef. More...

Data Fields
	$info = array()
	List of content set strings (pipe separators) indexed by name. More...
	$lookup = array()
	List of content set lookups (element => true) indexed by name. More...

Protected Member Functions
	convertToLookup ($string)
	Converts a string list of elements separated by pipes into a lookup array. More...

Protected Attributes
	$keys = array()
	Synchronized list of defined content sets (keys of info). More...
	$values = array()
	Synchronized list of defined content values (values of info). More...

Detailed Description

Todo:

Unit test

Definition at line 6 of file ContentSets.php.

Constructor & Destructor Documentation

__construct()

HTMLPurifier_ContentSets::__construct

(

$modules

)

Merges in module's content sets, expands identifiers in the content sets and populates the keys, values and lookup member variables.

Parameters

HTMLPurifier_HTMLModule[]

$modules

List of HTMLPurifier_HTMLModule

Definition at line 38 of file ContentSets.php.

    {
        if (!is_array($modules)) {
            $modules = array($modules);
        }
        // populate content_sets based on module hints
        // sorry, no way of overloading
        foreach ($modules as $module) {
            foreach ($module->content_sets as $key => $value) {
                $temp = $this->convertToLookup($value);
                if (isset($this->lookup[$key])) {
                    // add it into the existing content set
                    $this->lookup[$key] = array_merge($this->lookup[$key], $temp);
                } else {
                    $this->lookup[$key] = $temp;
                }
            }
        }
        $old_lookup = false;
        while ($old_lookup !== $this->lookup) {
            $old_lookup = $this->lookup;
            foreach ($this->lookup as $i => $set) {
                $add = array();
                foreach ($set as $element => $x) {
                    if (isset($this->lookup[$element])) {
                        $add += $this->lookup[$element];
                        unset($this->lookup[$i][$element]);
                    }
                }
                $this->lookup[$i] += $add;
            }
        }
 
        foreach ($this->lookup as $key => $lookup) {
            $this->info[$key] = implode(' | ', array_keys($lookup));
        }
        $this->keys   = array_keys($this->info);
        $this->values = array_values($this->info);
    }

References $lookup, $x, and convertToLookup().

Here is the call graph for this function:

Member Function Documentation

convertToLookup()

HTMLPurifier_ContentSets::convertToLookup (   $string )

protected

Converts a string list of elements separated by pipes into a lookup array.

Parameters

string

$string

List of elements

Returns

array Lookup array of elements

Definition at line 159 of file ContentSets.php.

    {
        $array = explode('|', str_replace(' ', '', $string));
        $ret = array();
        foreach ($array as $k) {
            $ret[$k] = true;
        }
        return $ret;
    }

References $ret.

Referenced by __construct().

Here is the caller graph for this function:

generateChildDef()

HTMLPurifier_ContentSets::generateChildDef	(	&	$def,
			$module
	)

Accepts a definition; generates and assigns a ChildDef for it.

Parameters

HTMLPurifier_ElementDef	$def	HTMLPurifier_ElementDef reference
HTMLPurifier_HTMLModule	$module	Module that defined the ElementDef

Definition at line 83 of file ContentSets.php.

    {
        if (!empty($def->child)) { // already done!
            return;
        }
        $content_model = $def->content_model;
        if (is_string($content_model)) {
            // Assume that $this->keys is alphanumeric
            $def->content_model = preg_replace_callback(
                '/\b(' . implode('|', $this->keys) . ')\b/',
                array($this, 'generateChildDefCallback'),
                $content_model
            );
            //$def->content_model = str_replace(
            //    $this->keys, $this->values, $content_model);
        }
        $def->child = $this->getChildDef($def, $module);
    }

References getChildDef().

Here is the call graph for this function:

generateChildDefCallback()

HTMLPurifier_ContentSets::generateChildDefCallback

(

$matches

)

Definition at line 102 of file ContentSets.php.

    {
        return $this->info[$matches[0]];
    }

getChildDef()

HTMLPurifier_ContentSets::getChildDef	(		$def,
			$module
	)

Instantiates a ChildDef based on content_model and content_model_type member variables in HTMLPurifier_ElementDef.

Note

This will also defer to modules for custom HTMLPurifier_ChildDef subclasses that need content set expansion

Parameters

HTMLPurifier_ElementDef	$def	HTMLPurifier_ElementDef to have ChildDef extracted
HTMLPurifier_HTMLModule	$module	Module that defined the ElementDef

Returns

HTMLPurifier_ChildDef corresponding to ElementDef

Definition at line 116 of file ContentSets.php.

    {
        $value = $def->content_model;
        if (is_object($value)) {
            trigger_error(
                'Literal object child definitions should be stored in '.
                'ElementDef->child not ElementDef->content_model',
                E_USER_NOTICE
            );
            return $value;
        }
        switch ($def->content_model_type) {
            case 'required':
                return new HTMLPurifier_ChildDef_Required($value);
            case 'optional':
                return new HTMLPurifier_ChildDef_Optional($value);
            case 'empty':
                return new HTMLPurifier_ChildDef_Empty();
            case 'custom':
                return new HTMLPurifier_ChildDef_Custom($value);
        }
        // defer to its module
        $return = false;
        if ($module->defines_child_def) { // save a func call
            $return = $module->getChildDef($def);
        }
        if ($return !== false) {
            return $return;
        }
        // error-out
        trigger_error(
            'Could not determine which ChildDef class to instantiate',
            E_USER_ERROR
        );
        return false;
    }

Referenced by generateChildDef().

Here is the caller graph for this function:

Field Documentation

$info

HTMLPurifier_ContentSets::$info = array()

List of content set strings (pipe separators) indexed by name.

@type array

Definition at line 13 of file ContentSets.php.

$keys

HTMLPurifier_ContentSets::$keys = array()

protected

Synchronized list of defined content sets (keys of info).

@type array

Definition at line 26 of file ContentSets.php.

$lookup

HTMLPurifier_ContentSets::$lookup = array()

List of content set lookups (element => true) indexed by name.

@type array

Note

This is in HTMLPurifier_HTMLDefinition->info_content_sets

Definition at line 20 of file ContentSets.php.

Referenced by __construct().

$values

HTMLPurifier_ContentSets::$values = array()

protected

Synchronized list of defined content values (values of info).

@type array

Definition at line 31 of file ContentSets.php.

---

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

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