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 ($children, $config, $context)
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
	bool
	$type = 'optional'
	string
Data Fields inherited from HTMLPurifier_ChildDef_Required
	$elements = array()
	Lookup table of allowed elements.
	$allow_empty = false
	bool
	$type = 'required'
	string
Data Fields inherited from HTMLPurifier_ChildDef
	$type
	Type of child definition, usually right-most part of class name lowercase.
	$allow_empty
	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	(		$children,
			$config,
			$context
	)

Parameters

array	$children
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns

array

Reimplemented from HTMLPurifier_ChildDef_Required.

Definition at line 28 of file Optional.php.

References $result.

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

Field Documentation

HTMLPurifier_ChildDef_Optional::$allow_empty = true

bool

Definition at line 15 of file Optional.php.

HTMLPurifier_ChildDef_Optional::$type = 'optional'

string

Definition at line 20 of file Optional.php.

---

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

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