HTMLPurifier_EntityParser Class Reference

Handles referencing and derefencing character entities. More...

Collaboration diagram for HTMLPurifier_EntityParser:

Public Member Functions
	substituteNonSpecialEntities ($string)
	Substitutes non-special entities with their parsed equivalents.
	substituteSpecialEntities ($string)
	Substitutes only special entities with their parsed equivalents.

Protected Member Functions
	nonSpecialEntityCallback ($matches)
	Callback function for substituteNonSpecialEntities() that does the work.
	specialEntityCallback ($matches)
	Callback function for substituteSpecialEntities() that does the work.

Protected Attributes
	$_entity_lookup
	Reference to entity lookup table.
	$_substituteEntitiesRegex
	Callback regex string for parsing entities.
	$_special_dec2str
	Decimal to parsed string conversion table for special entities.
	$_special_ent2dec
	Stripped entity names to decimal conversion table for special entities.

Detailed Description

Handles referencing and derefencing character entities.

Definition at line 10 of file EntityParser.php.

Member Function Documentation

HTMLPurifier_EntityParser::nonSpecialEntityCallback (   $matches )

protected

Callback function for substituteNonSpecialEntities() that does the work.

Parameters

$matches

PCRE matches array, with 0 the entire match, and either index 1, 2 or 3 set with a hex value, dec value, or string (respectively).

Returns

Replacement string.

Definition at line 75 of file EntityParser.php.

References HTMLPurifier_EntityLookup\instance(), and HTMLPurifier_Encoder\unichr().

                                                          {
        // replaces all but big five
        $entity = $matches[0];
        $is_num = (@$matches[0][1] === '#');
        if ($is_num) {
            $is_hex = (@$entity[2] === 'x');
            $code = $is_hex ? hexdec($matches[1]) : (int) $matches[2];

            // abort for special characters
            if (isset($this->_special_dec2str[$code]))  return $entity;

            return HTMLPurifier_Encoder::unichr($code);
        } else {
            if (isset($this->_special_ent2dec[$matches[3]])) return $entity;
            if (!$this->_entity_lookup) {
                $this->_entity_lookup = HTMLPurifier_EntityLookup::instance();
            }
            if (isset($this->_entity_lookup->table[$matches[3]])) {
                return $this->_entity_lookup->table[$matches[3]];
            } else {
                return $entity;
            }
        }
    }

Here is the call graph for this function:

HTMLPurifier_EntityParser::specialEntityCallback (   $matches )

protected

Callback function for substituteSpecialEntities() that does the work.

This callback has same syntax as nonSpecialEntityCallback().

Parameters

$matches

PCRE-style matches array, with 0 the entire match, and either index 1, 2 or 3 set with a hex value, dec value, or string (respectively).

Returns

Replacement string.

Definition at line 126 of file EntityParser.php.

                                                       {
        $entity = $matches[0];
        $is_num = (@$matches[0][1] === '#');
        if ($is_num) {
            $is_hex = (@$entity[2] === 'x');
            $int = $is_hex ? hexdec($matches[1]) : (int) $matches[2];
            return isset($this->_special_dec2str[$int]) ?
                $this->_special_dec2str[$int] :
                $entity;
        } else {
            return isset($this->_special_ent2dec[$matches[3]]) ?
                $this->_special_ent2dec[$matches[3]] :
                $entity;
        }
    }

HTMLPurifier_EntityParser::substituteNonSpecialEntities

(

$string

)

Substitutes non-special entities with their parsed equivalents.

Since running this whenever you have parsed character is t3h 5uck, we run it before everything else.

Parameters

$string

String to have non-special entities parsed.

Returns

Parsed string.

Definition at line 57 of file EntityParser.php.

                                                          {
        // it will try to detect missing semicolons, but don't rely on it
        return preg_replace_callback(
            $this->_substituteEntitiesRegex,
            array($this, 'nonSpecialEntityCallback'),
            $string
            );
    }

HTMLPurifier_EntityParser::substituteSpecialEntities

(

$string

)

Substitutes only special entities with their parsed equivalents.

We try to avoid calling this function because otherwise, it would have to be called a lot (for every parsed section).

Parameters

$string

String to have non-special entities parsed.

Returns

Parsed string.

Definition at line 109 of file EntityParser.php.

                                                       {
        return preg_replace_callback(
            $this->_substituteEntitiesRegex,
            array($this, 'specialEntityCallback'),
            $string);
    }

Field Documentation

HTMLPurifier_EntityParser::$_entity_lookup

protected

Reference to entity lookup table.

Definition at line 16 of file EntityParser.php.

HTMLPurifier_EntityParser::$_special_dec2str

protected

Initial value:

            array(
                    34 => '"',
                    38 => '&',
                    39 => "'",
                    60 => '<',
                    62 => '>'
            )

Decimal to parsed string conversion table for special entities.

Definition at line 29 of file EntityParser.php.

HTMLPurifier_EntityParser::$_special_ent2dec

protected

Initial value:

            array(
                    'quot' => 34,
                    'amp'  => 38,
                    'lt'   => 60,
                    'gt'   => 62
            )

Stripped entity names to decimal conversion table for special entities.

Definition at line 41 of file EntityParser.php.

HTMLPurifier_EntityParser::$_substituteEntitiesRegex

protected

Initial value:

'/&(?:[#]x([a-fA-F0-9]+)|[#]0*(\d+)|([A-Za-z_:][A-Za-z0-9.\-_:]*));?/'

Callback regex string for parsing entities.

Definition at line 21 of file EntityParser.php.

---

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

• Services/Html/HtmlPurifier/library/HTMLPurifier/EntityParser.php