HTMLPurifier_ChildDef_Custom Class Reference

Custom validation class, accepts DTD child definitions. More...

Inheritance diagram for HTMLPurifier_ChildDef_Custom:

Collaboration diagram for HTMLPurifier_ChildDef_Custom:

Public Member Functions
	__construct ($dtd_regex)
	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
	$type = 'custom'
	string More...
	$allow_empty = false
	bool More...
	$dtd_regex
	Allowed child pattern as defined by the DTD. 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...

Protected Member Functions
	_compileRegex ()
	Compiles the PCRE regex from a DTD regex ($dtd_regex to $_pcre_regex) More...

Private Attributes
	$_pcre_regex
	PCRE regex derived from $dtd_regex. More...

Detailed Description

Custom validation class, accepts DTD child definitions.

Warning

Currently this class is an all or nothing proposition, that is, it will only give a bool return value.

Definition at line 9 of file Custom.php.

Constructor & Destructor Documentation

__construct()

HTMLPurifier_ChildDef_Custom::__construct

(

$dtd_regex

)

Parameters

$dtd_regex

Allowed child pattern from the DTD

Definition at line 36 of file Custom.php.

References $dtd_regex, and _compileRegex().

    {
        $this->dtd_regex = $dtd_regex;
        $this->_compileRegex();
    }

Here is the call graph for this function:

Member Function Documentation

_compileRegex()

HTMLPurifier_ChildDef_Custom::_compileRegex ( )

protected

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

Definition at line 45 of file Custom.php.

Referenced by __construct().

    {
        $raw = str_replace(' ', '', $this->dtd_regex);
        if ($raw{0} != '(') {
            $raw = "($raw)";
        }
        $el = '[#a-zA-Z0-9_.-]+';
        $reg = $raw;

        // COMPLICATED! AND MIGHT BE BUGGY! I HAVE NO CLUE WHAT I'M
        // DOING! Seriously: if there's problems, please report them.

        // collect all elements into the $elements array
        preg_match_all("/$el/", $reg, $matches);
        foreach ($matches[0] as $match) {
            $this->elements[$match] = true;
        }

        // setup all elements as parentheticals with leading commas
        $reg = preg_replace("/$el/", '(,\\0)', $reg);

        // remove commas when they were not solicited
        $reg = preg_replace("/([^,(|]\(+),/", '\\1', $reg);

        // remove all non-paranthetical commas: they are handled by first regex
        $reg = preg_replace("/,\(/", '(', $reg);

        $this->_pcre_regex = $reg;
    }

Here is the caller graph for this function:

validateChildren()

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

Parameters

	HTMLPurifier_Node[]	$children
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns

bool

Definition at line 81 of file Custom.php.

    {
        $list_of_children = '';
        $nesting = 0; // depth into the nest
        foreach ($children as $node) {
            if (!empty($node->is_whitespace)) {
                continue;
            }
            $list_of_children .= $node->name . ',';
        }
        // add leading comma to deal with stray comma declarations
        $list_of_children = ',' . rtrim($list_of_children, ',');
        $okay =
            preg_match(
                '/^,?' . $this->_pcre_regex . '$/',
                $list_of_children
            );
        return (bool)$okay;
    }

Field Documentation

$_pcre_regex

HTMLPurifier_ChildDef_Custom::$_pcre_regex

private

PCRE regex derived from $dtd_regex.

string

Definition at line 31 of file Custom.php.

$allow_empty

HTMLPurifier_ChildDef_Custom::$allow_empty = false

bool

Definition at line 19 of file Custom.php.

$dtd_regex

HTMLPurifier_ChildDef_Custom::$dtd_regex

Allowed child pattern as defined by the DTD.

string

Definition at line 25 of file Custom.php.

Referenced by __construct().

$type

HTMLPurifier_ChildDef_Custom::$type = 'custom'

string

Definition at line 14 of file Custom.php.

---

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

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