Moodle  2.2.1
http://www.collinsharper.com
HTMLPurifier_Lexer_DOMLex Class Reference
Inheritance diagram for HTMLPurifier_Lexer_DOMLex:
Collaboration diagram for HTMLPurifier_Lexer_DOMLex:

Public Member Functions

 __construct ()
 tokenizeHTML ($html, $config, $context)
 muteErrorHandler ($errno, $errstr)
 callbackUndoCommentSubst ($matches)
 callbackArmorCommentEntities ($matches)

Protected Member Functions

 tokenizeDOM ($node, &$tokens)
 createStartNode ($node, &$tokens, $collect)
 createEndNode ($node, &$tokens)
 transformAttrToAssoc ($node_map)
 wrapHTML ($html, $config, $context)

Detailed Description

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.

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

Definition at line 27 of file DOMLex.php.


Constructor & Destructor Documentation

Reimplemented from HTMLPurifier_Lexer.

Definition at line 32 of file DOMLex.php.


Member Function Documentation

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

Definition at line 216 of file DOMLex.php.

callbackUndoCommentSubst ( matches)

Callback function for undoing escaping of stray angled brackets in comments

Definition at line 208 of file DOMLex.php.

createEndNode ( node,
&$  tokens 
) [protected]

Definition at line 176 of file DOMLex.php.

Here is the caller graph for this function:

createStartNode ( node,
&$  tokens,
collect 
) [protected]
Parameters:
$nodeDOMNode to be tokenized.
$tokensArray-list of already tokenized tokens.
$collectSays whether or start and close are collected, set to false at first recursion because it's the implicit DIV tag you're dealing with.
Returns:
bool if the token needs an endtoken

Definition at line 119 of file DOMLex.php.

Here is the call graph for this function:

Here is the caller graph for this function:

muteErrorHandler ( errno,
errstr 
)

An error handler that mutes all errors

Definition at line 202 of file DOMLex.php.

tokenizeDOM ( node,
&$  tokens 
) [protected]

Iterative function that tokenizes a node, putting it into an accumulator. To iterate is human, to recurse divine - L. Peter Deutsch

Parameters:
$nodeDOMNode to be tokenized.
$tokensArray-list of already tokenized tokens.
Returns:
Tokens of node appended to previously passed tokens.

Definition at line 81 of file DOMLex.php.

Here is the call graph for this function:

Here is the caller graph for this function:

tokenizeHTML ( string,
config,
context 
)

Lexes an HTML string into tokens.

Parameters:
$stringString HTML.
Returns:
HTMLPurifier_Token array representation of HTML.

Reimplemented from HTMLPurifier_Lexer.

Reimplemented in HTMLPurifier_Lexer_PH5P.

Definition at line 38 of file DOMLex.php.

Here is the call graph for this function:

transformAttrToAssoc ( node_map) [protected]

Converts a DOMNamedNodeMap of DOMAttr objects into an assoc array.

Parameters:
$attribute_listDOMNamedNodeMap of DOMAttr objects.
Returns:
Associative array of attributes.

Definition at line 187 of file DOMLex.php.

Here is the caller graph for this function:

wrapHTML ( html,
config,
context 
) [protected]

Wraps an HTML fragment in the necessary HTML

Definition at line 223 of file DOMLex.php.

Here is the caller graph for this function:


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations