Defines allowed child nodes and validates tokens against it. More...

Inheritance diagram for HTMLPurifier_ChildDef:

Collaboration diagram for HTMLPurifier_ChildDef:

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

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

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

	$allow_empty
	Bool that 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...

Detailed Description

Defines allowed child nodes and validates tokens against it.

Definition at line 6 of file ChildDef.php.

Member Function Documentation

◆ getAllowedElements()

HTMLPurifier_ChildDef::getAllowedElements ( $config )

Get lookup of tag names that should not close this element automatically.

All other elements will do so.

Definition at line 31 of file ChildDef.php.

References $elements, and validateChildren().

                                                 {
         return $this->elements;
     }

Here is the call graph for this function:

◆ validateChildren()

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

abstract

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

Referenced by getAllowedElements().

Here is the caller graph for this function:

Field Documentation

◆ $allow_empty

HTMLPurifier_ChildDef::$allow_empty

Bool that indicates whether or not an empty array of children is okay.

This is necessary for redundant checking when changes affecting a child node may cause a parent node to now be disallowed.

Definition at line 20 of file ChildDef.php.

◆ $elements

HTMLPurifier_ChildDef::$elements = array()

Lookup array of all elements that this definition could possibly allow.

Definition at line 25 of file ChildDef.php.

Referenced by getAllowedElements().

◆ $type

HTMLPurifier_ChildDef::$type

Type of child definition, usually right-most part of class name lowercase.

Used occasionally in terms of context.

Definition at line 12 of file ChildDef.php.

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

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

Public Member Functions

Data Fields