Defines allowed child nodes and validates nodes 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 ($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
	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 nodes 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.

Parameters

HTMLPurifier_Config $config HTMLPurifier_Config object

Returns: array

Reimplemented in HTMLPurifier_ChildDef_StrictBlockquote.

Definition at line 36 of file ChildDef.php.

    {
        return $this->elements;
    }

References $elements.

◆ validateChildren()

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

abstract

Validates nodes according to definition and returns modification.

Parameters

HTMLPurifier_Node[]	$children	Array of HTMLPurifier_Node
HTMLPurifier_Config	$config	HTMLPurifier_Config object
HTMLPurifier_Context	$context	HTMLPurifier_Context object

Returns: bool|array true to leave nodes as is, false to remove parent node, array of replacement children

Reimplemented in HTMLPurifier_ChildDef_Chameleon, HTMLPurifier_ChildDef_Custom, HTMLPurifier_ChildDef_Empty, HTMLPurifier_ChildDef_List, HTMLPurifier_ChildDef_Optional, HTMLPurifier_ChildDef_Required, HTMLPurifier_ChildDef_StrictBlockquote, and HTMLPurifier_ChildDef_Table.

Field Documentation

◆ $allow_empty

HTMLPurifier_ChildDef::$allow_empty

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

Definition at line 22 of file ChildDef.php.

◆ $elements

HTMLPurifier_ChildDef::$elements = array()

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

@type array

Definition at line 28 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. @type string

Definition at line 13 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