\HTMLPurifier_Lexer_DOMLex

Parser that uses PHP 5's DOM extension (part of the core).

In PHP 5, the DOM XML extension was revamped into DOM and added to the core. It gives us a forgiving HTML parser, which we use to transform the HTML into a DOM, and then into the tokens. It is blazingly fast (for large documents, it performs twenty times faster than HTMLPurifier_Lexer_DirectLex,and is the default choice for PHP 5.

Summary

Methods

Properties

Constants

create()
__construct()
parseText()
parseAttr()
parseData()
tokenizeHTML()
normalize()
extractBody()
muteErrorHandler()
callbackUndoCommentSubst()
callbackArmorCommentEntities()

$tracksLineNumbers

No constants found

escapeCDATA()
escapeCommentedCDATA()
removeIEConditional()
CDATACallback()
tokenizeDOM()
getTagName()
getData()
createStartNode()
createEndNode()
transformAttrToAssoc()
wrapHTML()

$_special_entity2str

N/A

No private methods found

$factory

N/A

File: vendor/ezyang/htmlpurifier/library/HTMLPurifier/Lexer/DOMLex.php
Package: Default
Class hierarchy: \HTMLPurifier_Lexer

\HTMLPurifier_Lexer_DOMLex

Tags

note

Any empty elements will have empty tokens associated with them, even if this is prohibited by the spec. This is cannot be fixed until the spec comes into play.

PHP's DOM extension does not actually parse any entities, we use our own function to do that.

warning

DOM tends to drop whitespace, which may wreak havoc on indenting. If this is a huge problem, due to the fact that HTML is hand edited and you are unable to get a parser cache that caches the the output of HTML Purifier while keeping the original HTML lying around, you may want to run Tidy on the resulting output or use HTMLPurifier_DirectLex

Properties

$tracksLineNumbers

$tracksLineNumbers :

Whether or not this lexer implements line-number/column-number tracking.

If it does, set to true.

Type

$_special_entity2str

$_special_entity2str :

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

Type

Inherited from: \HTMLPurifier_Lexer

Tags

type	array

$factory

$factory :

Type

Tags

type	HTMLPurifier_TokenFactory

Methods

create()

create(\HTMLPurifier_Config  $config) : \HTMLPurifier_Lexer

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

\HTMLPurifier_Config

$config

Throws

\HTMLPurifier_Exception

Returns

\HTMLPurifier_Lexer

static

Inherited from: \HTMLPurifier_Lexer

Tags

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.

__construct()

__construct()

parseText()

parseText(  $string,   $config)

Parameters

	$string
	$config

parseAttr()

parseAttr(  $string,   $config)

Parameters

	$string
	$config

parseData()

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

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.
	$is_attr
	$config

Returns

string —

Parsed character data.

tokenizeHTML()

tokenizeHTML(string  $html, \HTMLPurifier_Config  $config, \HTMLPurifier_Context  $context) : array<mixed,\HTMLPurifier_Token>

Lexes an HTML string into tokens.

Parameters

string	$html
\HTMLPurifier_Config	$config
\HTMLPurifier_Context	$context

Returns

array<mixed,\HTMLPurifier_Token>

normalize()

normalize(string  $html, \HTMLPurifier_Config  $config, \HTMLPurifier_Context  $context) : string

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

Inherited from: \HTMLPurifier_Lexer

Tags

todo	Consider making protected

extractBody()

extractBody(  $html)

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

Parameters

$html

Inherited from: \HTMLPurifier_Lexer

Tags

todo	Consider making protected

muteErrorHandler()

muteErrorHandler(integer  $errno, string  $errstr)

An error handler that mutes all errors

Parameters

integer	$errno
string	$errstr

callbackUndoCommentSubst()

callbackUndoCommentSubst(array  $matches) : string

Callback function for undoing escaping of stray angled brackets in comments

Parameters

array

$matches

Returns

string

callbackArmorCommentEntities()

callbackArmorCommentEntities(array  $matches) : string

Callback function that entity-izes ampersands in comments so that callbackUndoCommentSubst doesn't clobber them

Parameters

array

$matches

Returns

string

escapeCDATA()

escapeCDATA(string  $string) : string

Translates CDATA sections into regular sections (through escaping).

Parameters

string

$string

HTML string to process.

Returns

string —

HTML with CDATA sections escaped.

escapeCommentedCDATA()

escapeCommentedCDATA(string  $string) : string

Special CDATA case that is especially convoluted for <script>

Parameters

string

$string

HTML string to process.

Returns

string —

HTML with CDATA sections escaped.

removeIEConditional()

removeIEConditional(string  $string) : string

Special Internet Explorer conditional comments should be removed.

Parameters

string

$string

HTML string to process.

Returns

string —

HTML with conditional comments removed.

CDATACallback()

CDATACallback(array  $matches) : string

Callback function for escapeCDATA() that does the work.

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.

static

Inherited from: \HTMLPurifier_Lexer

Tags

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

tokenizeDOM()

tokenizeDOM(\DOMNode  $node, array<mixed,\HTMLPurifier_Token>  $tokens,   $config) : \HTMLPurifier_Token

Iterative function that tokenizes a node, putting it into an accumulator.

To iterate is human, to recurse divine - L. Peter Deutsch

Parameters

\DOMNode	$node	DOMNode to be tokenized.
array<mixed,\HTMLPurifier_Token>	$tokens	Array-list of already tokenized tokens.
	$config

Returns

\HTMLPurifier_Token —

of node appended to previously passed tokens.

getTagName()

getTagName(\DOMNode  $node)

Portably retrieve the tag name of a node; deals with older versions of libxml like 2.7.6

Parameters

\DOMNode

$node

getData()

getData(\DOMNode  $node)

Portably retrieve the data of a node; deals with older versions of libxml like 2.7.6

Parameters

\DOMNode

$node

createStartNode()

createStartNode(\DOMNode  $node, array<mixed,\HTMLPurifier_Token>  $tokens, boolean  $collect,   $config) : boolean

Parameters

\DOMNode	$node	DOMNode to be tokenized.
array<mixed,\HTMLPurifier_Token>	$tokens	Array-list of already tokenized tokens.
boolean	$collect	Says whether or start and close are collected, set to false at first recursion because it's the implicit DIV tag you're dealing with.
	$config

Returns

boolean —

if the token needs an endtoken

Inherited from: \HTMLPurifier_Lexer_DOMLex

Tags

todo	data and tagName properties don't seem to exist in DOMNode?

createEndNode()

createEndNode(\DOMNode  $node, array<mixed,\HTMLPurifier_Token>  $tokens)

Parameters

\DOMNode	$node
array<mixed,\HTMLPurifier_Token>	$tokens

transformAttrToAssoc()

transformAttrToAssoc(\DOMNamedNodeMap  $node_map) : array

Converts a DOMNamedNodeMap of DOMAttr objects into an assoc array.

Parameters

\DOMNamedNodeMap

$node_map

DOMNamedNodeMap of DOMAttr objects.

Returns

array —

Associative array of attributes.

wrapHTML()

wrapHTML(string  $html, \HTMLPurifier_Config  $config, \HTMLPurifier_Context  $context,   $use_div = true) : string

Wraps an HTML fragment in the necessary HTML

Parameters

string	$html
\HTMLPurifier_Config	$config
\HTMLPurifier_Context	$context
	$use_div

Returns

string