HTMLPurifier_ChildDef_Optional Class Reference

Definition that allows a set of elements, and allows no children. More...

Inheritance diagram for HTMLPurifier_ChildDef_Optional:

Collaboration diagram for HTMLPurifier_ChildDef_Optional:

Public Member Functions
	validateChildren ($tokens_of_children, $config, $context)
	Validates nodes according to definition and returns modification.
Public Member Functions inherited from HTMLPurifier_ChildDef_Required
	__construct ($elements)
Public Member Functions inherited from HTMLPurifier_ChildDef
	getAllowedElements ($config)
	Get lookup of tag names that should not close this element automatically.

Data Fields
	$allow_empty = true
	$type = 'optional'
Data Fields inherited from HTMLPurifier_ChildDef_Required
	$elements = array()
	Lookup table of allowed elements.
	$allow_empty = false
	$type = 'required'
Data Fields inherited from HTMLPurifier_ChildDef
	$type
	Type of child definition, usually right-most part of class name lowercase.
	$allow_empty
	Bool that indicates whether or not an empty array of children is okay.
	$elements = array()
	Lookup array of all elements that this definition could possibly allow.

Additional Inherited Members
Protected Attributes inherited from HTMLPurifier_ChildDef_Required
	$whitespace = false
	Whether or not the last passed node was all whitespace.

Detailed Description

Definition that allows a set of elements, and allows no children.

Note

This is a hack to reuse code from HTMLPurifier_ChildDef_Required, really, one shouldn't inherit from the other. Only altered behavior is to overload a returned false with an array. Thus, it will never return false.

Definition at line 10 of file Optional.php.

Member Function Documentation

HTMLPurifier_ChildDef_Optional::validateChildren	(		$tokens_of_children,
			$config,
			$context
	)

Validates nodes according to definition and returns modification.

Parameters

$tokens_of_children	Array of HTMLPurifier_Token
$config	HTMLPurifier_Config object
$context	HTMLPurifier_Context object

Returns

bool true to leave nodes as is

bool false to remove parent node

array of replacement child tokens

Reimplemented from HTMLPurifier_ChildDef_Required.

Definition at line 14 of file Optional.php.

References $config.

                                                                             {
        $result = parent::validateChildren($tokens_of_children, $config, $context);
        // we assume that $tokens_of_children is not modified
        if ($result === false) {
            if (empty($tokens_of_children)) return true;
            elseif ($this->whitespace) return $tokens_of_children;
            else return array();
        }
        return $result;
    }

Field Documentation

HTMLPurifier_ChildDef_Optional::$allow_empty = true

Definition at line 12 of file Optional.php.

HTMLPurifier_ChildDef_Optional::$type = 'optional'

Definition at line 13 of file Optional.php.

---

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

• Services/Html/HtmlPurifier/library/HTMLPurifier/ChildDef/Optional.php