\HTMLPurifier_ChildDef_Custom

Custom validation class, accepts DTD child definitions

Summary

Methods
Properties
Constants
getAllowedElements()
validateChildren()
__construct()
$type
$allow_empty
$elements
$dtd_regex
No constants found
_compileRegex()
No protected properties found
N/A
No private methods found
$_pcre_regex
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

$dtd_regex

$dtd_regex : 

Allowed child pattern as defined by the DTD.

Type

$_pcre_regex

$_pcre_regex : 

PCRE regex derived from $dtd_regex.

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(  $dtd_regex) 

Parameters

$dtd_regex

Allowed child pattern from the DTD

_compileRegex()

_compileRegex() 

Compiles the PCRE regex from a DTD regex ($dtd_regex to $_pcre_regex)