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)

	validateChildren ($children, $config, $context)

Public Member Functions inherited from HTMLPurifier_ChildDef
	getAllowedElements ($config)
	Get lookup of tag names that should not close this element automatically. More...

	validateChildren ($children, $config, $context)
	Validates nodes according to definition and returns modification. More...

Data Fields
	$allow_empty = true
	@type bool More...

	$type = 'optional'
	@type string More...

Data Fields inherited from HTMLPurifier_ChildDef_Required
	$elements = array()
	Lookup table of allowed elements. More...

	$allow_empty = false
	@type bool More...

	$type = 'required'
	@type string More...

Data Fields inherited from HTMLPurifier_ChildDef
	$type
	Type of child definition, usually right-most part of class name lowercase. More...

	$allow_empty
	Indicates whether or not an empty array of children is okay. More...

	$elements = array()
	Lookup array of all elements that this definition could possibly allow. More...

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

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

◆ validateChildren()

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.

    {
        $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;
    }

References $result.

Field Documentation

◆ $allow_empty

HTMLPurifier_ChildDef_Optional::$allow_empty = true

@type bool

Definition at line 15 of file Optional.php.

◆ $type

HTMLPurifier_ChildDef_Optional::$type = 'optional'

@type 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

Public Member Functions