[ Index ]

PHP Cross Reference of Moodle 1.9.3 [Build 15-Oct-2008]

title

Body

[close]

/lib/htmlpurifier/HTMLPurifier/ -> Lexer.php (summary)

(no description)

File Size: 363 lines (13 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

HTMLPurifier_Lexer:: (9 methods):
  create()
  HTMLPurifier_Lexer()
  parseData()
  tokenizeHTML()
  escapeCDATA()
  escapeCommentedCDATA()
  CDATACallback()
  normalize()
  extractBody()


Class: HTMLPurifier_Lexer  - X-Ref

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 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.

create($config)   X-Ref
Retrieves or sets the default Lexer as a Prototype Factory.

Depending on what PHP version you are running, the abstract base
Lexer class will determine which concrete Lexer is best for you:
HTMLPurifier_Lexer_DirectLex for PHP 4, and HTMLPurifier_Lexer_DOMLex
for PHP 5 and beyond.  This general rule has a few exceptions to it
involving special features that only DirectLex implements.

param: $prototype Optional prototype lexer or configuration object
return: Concrete lexer.

HTMLPurifier_Lexer()   X-Ref
No description

parseData($string)   X-Ref
Parses special entities into the proper characters.

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

returns: Parsed character data.
param: $string String character data to be parsed.

tokenizeHTML($string, $config, &$context)   X-Ref
Lexes an HTML string into tokens.

param: $string String HTML.
return: HTMLPurifier_Token array representation of HTML.

escapeCDATA($string)   X-Ref
Translates CDATA sections into regular sections (through escaping).

returns: HTML with CDATA sections escaped.
param: $string HTML string to process.

escapeCommentedCDATA($string)   X-Ref
Special CDATA case that is especiall convoluted for <script>


CDATACallback($matches)   X-Ref
Callback function for escapeCDATA() that does the work.

returns: Escaped internals of the CDATA section.

normalize($html, $config, &$context)   X-Ref
Takes a piece of HTML and normalizes it by converting entities, fixing
encoding, extracting bits, and other good stuff.


extractBody($html)   X-Ref
Takes a string of HTML (fragment or document) and returns the content




Generated: Wed Jan 14 11:33:29 2009 Cross-referenced by PHPXref 0.7