\HTMLPurifier_ChildDef_Chameleon

Definition that uses different definitions depending on context.

The del and ins tags are notable because they allow different types of elements depending on whether or not they're in a block or inline context. Chameleon allows this behavior to happen by using two different definitions depending on context. While this somewhat generalized, it is specifically intended for those two tags.

Summary

Methods
Properties
Constants
getAllowedElements()
validateChildren()
__construct()
$type
$allow_empty
$elements
$inline
$block
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$type

$type : 

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

Used occasionally in terms of context.

Type

$allow_empty

$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

$elements

$elements : 

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

Type

$inline

$inline : 

Instance of the definition object to use when inline. Usually stricter.

Type

$block

$block : 

Instance of the definition object to use when block.

Type

Methods

getAllowedElements()

getAllowedElements(\HTMLPurifier_Config  $config) : array

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

validateChildren()

validateChildren(array<mixed,\HTMLPurifier_Node>  $children, \HTMLPurifier_Config  $config, \HTMLPurifier_Context  $context) : boolean

Validates nodes according to definition and returns modification.

Parameters

array<mixed,\HTMLPurifier_Node> $children

Array of HTMLPurifier_Node

\HTMLPurifier_Config $config

HTMLPurifier_Config object

\HTMLPurifier_Context $context

HTMLPurifier_Context object

Returns

boolean

__construct()

__construct(array  $inline, array  $block) 

Parameters

array $inline

List of elements to allow when inline.

array $block

List of elements to allow when block.