Inheritance diagram for HTMLPurifier_Lexer:

Public Member Functions
	__construct ()

	parseText ($string, $config)

	parseAttr ($string, $config)

	parseData ($string, $is_attr, $config)

	tokenizeHTML ($string, $config, $context)

	normalize ($html, $config, $context)

	extractBody ($html)

Static Public Member Functions
static	create ($config)

Public Attributes
	$tracksLineNumbers = false

Static Protected Member Functions
static	escapeCDATA ($string)

static	escapeCommentedCDATA ($string)

static	removeIEConditional ($string)

static	CDATACallback ($matches)

Protected Attributes
	$_special_entity2str

Detailed Description

Forgivingly lexes HTML (SGML-style) markup into tokens.

A lexer parses a string of SGML-style markup and converts them into corresponding tokens. It doesn't check for well-formedness, although its internal mechanism may make this automatic (such as the case of HTMLPurifier_Lexer_DOMLex). There are several implementations to choose from.

A lexer is HTML-oriented: it might work with XML, but it's not recommended, as we adhere to a subset of the specification for optimization reasons. This might change in the future. Also, most tokenizers are not expected to handle DTDs or PIs.

This class should not be directly instantiated, but you may use create() to retrieve a default copy of the lexer. Being a supertype, this class does not actually define any implementation, but offers commonly used convenience functions for subclasses.

Note: The unit tests will instantiate this class for testing purposes, as many of the utility functions require a class to be instantiated. This means that, even though this class is not runnable, it will not be declared abstract.

Note: We use tokens rather than create a DOM representation because DOM would:

Require more processing and memory to create,
Is not streamable, and
Has the entire document structure (html and body not needed).

: However, DOM is helpful in that it makes it easy to move around nodes without a lot of lookaheads to see when a tag is closed. This is a limitation of the token system and some workarounds would be nice.

Definition at line 7664 of file HTMLPurifier.standalone.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLPurifier_Lexer::__construct ( )

Reimplemented in HTMLPurifier_Lexer_DOMLex.

Definition at line 7774 of file HTMLPurifier.standalone.php.

Member Function Documentation

◆ CDATACallback()

static HTMLPurifier_Lexer::CDATACallback ( $matches )

staticprotected

Callback function for escapeCDATA() that does the work.

Warning: Though this is public in order to let the callback happen, calling it directly is not recommended.

Parameters

array $matches PCRE matches array, with index 0 the entire match and 1 the inside of the CDATA section.

Returns: string Escaped internals of the CDATA section.

Definition at line 7912 of file HTMLPurifier.standalone.php.

◆ create()

static HTMLPurifier_Lexer::create ( $config )

static

Retrieves or sets the default Lexer as a Prototype Factory.

By default HTMLPurifier_Lexer_DOMLex will be returned. There are a few exceptions involving special features that only DirectLex implements.

Note: The behavior of this class has changed, rather than accepting a prototype object, it now accepts a configuration object. To specify your own prototype, set Core.LexerImpl to it. This change in behavior de-singletonizes the lexer object.

Parameters

HTMLPurifier_Config $config

Returns: HTMLPurifier_Lexer

Exceptions

HTMLPurifier_Exception

Definition at line 7691 of file HTMLPurifier.standalone.php.

◆ escapeCDATA()

static HTMLPurifier_Lexer::escapeCDATA ( $string )

staticprotected

Translates CDATA sections into regular sections (through escaping).

Parameters

string $string HTML string to process.

Returns: string HTML with CDATA sections escaped.

Definition at line 7866 of file HTMLPurifier.standalone.php.

◆ escapeCommentedCDATA()

static HTMLPurifier_Lexer::escapeCommentedCDATA ( $string )

staticprotected

Special CDATA case that is especially convoluted for <script>

Parameters

string $string HTML string to process.

Returns: string HTML with CDATA sections escaped.

Definition at line 7880 of file HTMLPurifier.standalone.php.

◆ extractBody()

HTMLPurifier_Lexer::extractBody ( $html )

Takes a string of HTML (fragment or document) and returns the content

Definition at line 7987 of file HTMLPurifier.standalone.php.

◆ normalize()

HTMLPurifier_Lexer::normalize	(	$html,
		$config,
		$context
	)

Takes a piece of HTML and normalizes it by converting entities, fixing encoding, extracting bits, and other good stuff.

Parameters

string	$html	HTML.
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns: string

Definition at line 7927 of file HTMLPurifier.standalone.php.

◆ parseAttr()

HTMLPurifier_Lexer::parseAttr	(	$string,
		$config
	)

Definition at line 7798 of file HTMLPurifier.standalone.php.

◆ parseData()

HTMLPurifier_Lexer::parseData	(	$string,
		$is_attr,
		$config
	)

Parses special entities into the proper characters.

This string will translate escaped versions of the special characters into the correct ones.

Parameters

string $string String character data to be parsed.

Returns: string Parsed character data.

Definition at line 7811 of file HTMLPurifier.standalone.php.

◆ parseText()

HTMLPurifier_Lexer::parseText	(	$string,
		$config
	)

Definition at line 7794 of file HTMLPurifier.standalone.php.

◆ removeIEConditional()

static HTMLPurifier_Lexer::removeIEConditional ( $string )

staticprotected

Special Internet Explorer conditional comments should be removed.

Parameters

string $string HTML string to process.

Returns: string HTML with conditional comments removed.

Definition at line 7894 of file HTMLPurifier.standalone.php.

◆ tokenizeHTML()

HTMLPurifier_Lexer::tokenizeHTML	(	$string,
		$config,
		$context
	)

Lexes an HTML string into tokens.

Parameters

	$string	String HTML.
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns: HTMLPurifier_Token[] array representation of HTML.

Reimplemented in HTMLPurifier_Lexer_PH5P, HTMLPurifier_Lexer_DirectLex, and HTMLPurifier_Lexer_DOMLex.

Definition at line 7856 of file HTMLPurifier.standalone.php.

Member Data Documentation

◆ $_special_entity2str

HTMLPurifier_Lexer::$_special_entity2str

protected

Initial value:

=
        array(
            '&quot;' => '"',
            '&amp;' => '&',
            '&lt;' => '<',
            '&gt;' => '>',
            '&#39;' => "'",
            '&#039;' => "'",
            '&#x27;' => "'"
        )

Most common entity to raw value conversion table for special entities. @type array

Definition at line 7783 of file HTMLPurifier.standalone.php.

◆ $tracksLineNumbers

HTMLPurifier_Lexer::$tracksLineNumbers = false

Whether or not this lexer implements line-number/column-number tracking. If it does, set to true.

Definition at line 7671 of file HTMLPurifier.standalone.php.

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

plugins/htmlpurifier/HTMLPurifier.standalone.php

Public Member Functions

Static Public Member Functions

Public Attributes

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ CDATACallback()

◆ create()

◆ escapeCDATA()

◆ escapeCommentedCDATA()

◆ extractBody()

◆ normalize()

◆ parseAttr()

◆ parseData()

◆ parseText()

◆ removeIEConditional()

◆ tokenizeHTML()

Member Data Documentation

◆ $_special_entity2str

◆ $tracksLineNumbers