Class HTMLPurifier_Lexer

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.

Direct known subclasses

HTMLPurifier_Lexer_DirectLex, HTMLPurifier_Lexer_DOMLex

Indirect known subclasses

HTMLPurifier_Lexer_PH5P

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:
Par
Par: -# Require more processing and memory to create, -# Is not streamable, and -# Has the entire document structure (html and body not needed).
Par: 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.
Located at x2engine/framework/vendors/htmlpurifier/HTMLPurifier.standalone.php

Methods summary
`public static HTMLPurifier_Lexer`	# `create( HTMLPurifier_Config $config )` Retrieves or sets the default Lexer as a Prototype Factory. 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. Parameters `$config` `HTMLPurifier_Config` $config Returns `HTMLPurifier_Lexer` Throws `HTMLPurifier_Exception` 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.
`public`	# `__construct( )`
`public string`	# `parseData( string $string )` Parses special entities into the proper characters. 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 String character data to be parsed. Returns `string` Parsed character data. Warning You should be able to treat the output of this function as completely parsed, but that's only because all other entities should have been handled previously in substituteNonSpecialEntities()
`public HTMLPurifier_Token[]`	# `tokenizeHTML( mixed $string, HTMLPurifier_Config $config, HTMLPurifier_Context $context )` Lexes an HTML string into tokens. Lexes an HTML string into tokens. Parameters `$string` `mixed` $string String HTML. `$config` `HTMLPurifier_Config` $config `$context` `HTMLPurifier_Context` $context Returns `HTMLPurifier_Token[]` array representation of HTML.
`protected static string`	# `escapeCDATA( string $string )` Translates CDATA sections into regular sections (through escaping). Translates CDATA sections into regular sections (through escaping). Parameters `$string` `string` $string HTML string to process. Returns `string` HTML with CDATA sections escaped.
`protected static string`	# `escapeCommentedCDATA( string $string )` Special CDATA case that is especially convoluted for <script> Special CDATA case that is especially convoluted for <script> Parameters `$string` `string` $string HTML string to process. Returns `string` HTML with CDATA sections escaped.
`protected static string`	# `removeIEConditional( string $string )` Special Internet Explorer conditional comments should be removed. Special Internet Explorer conditional comments should be removed. Parameters `$string` `string` $string HTML string to process. Returns `string` HTML with conditional comments removed.
`protected static string`	# `CDATACallback( array $matches )` Callback function for escapeCDATA() that does the work. Callback function for escapeCDATA() that does the work. Parameters `$matches` `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. Warning Though this is public in order to let the callback happen, calling it directly is not recommended.
`public string`	# `normalize( string $html, HTMLPurifier_Config $config, HTMLPurifier_Context $context )` Takes a piece of HTML and normalizes it by converting entities, fixing encoding, extracting bits, and other good stuff. Takes a piece of HTML and normalizes it by converting entities, fixing encoding, extracting bits, and other good stuff. Parameters `$html` `string` $html HTML. `$config` `HTMLPurifier_Config` $config `$context` `HTMLPurifier_Context` $context Returns `string`
`public`	# `extractBody( mixed $html )` Takes a string of HTML (fragment or document) and returns the content Takes a string of HTML (fragment or document) and returns the content

Properties summary
`public boolean`	`$tracksLineNumbers`	`false`	# Whether or not this lexer implements line-number/column-number tracking. If it does, set to true. Whether or not this lexer implements line-number/column-number tracking. If it does, set to true.
`protected array`	`$_special_entity2str`	`array( '"' => '"', '&' => '&', '<' => '<', '>' => '>', ''' => "'", ''' => "'", ''' => "'" )`	# Most common entity to raw value conversion table for special entities. Most common entity to raw value conversion table for special entities. Type array

Packages

Classes

Interfaces

Exceptions

Functions

Class HTMLPurifier_Lexer

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Throws

Note

Parameters

Returns

Warning

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Warning

Parameters

Returns

Type