BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
Preprocessor_DOM Class Reference
Inheritance diagram for Preprocessor_DOM:
Collaboration diagram for Preprocessor_DOM:

Public Member Functions

 __construct ($parser)
 
 newFrame ()
 
 newCustomFrame ($args)
 
 newPartNodeArray ($values)
 
 memCheck ()
 
 preprocessToObj ($text, $flags=0)
 
 preprocessToXml ($text, $flags=0)
 
- Public Member Functions inherited from Preprocessor
 newFrame ()
 
 newCustomFrame ($args)
 
 newPartNodeArray ($values)
 
 preprocessToObj ($text, $flags=0)
 

Public Attributes

 $parser
 
 $memoryLimit
 
const CACHE_PREFIX = 'preprocess-xml'
 
- Public Attributes inherited from Preprocessor
const CACHE_VERSION = 1
 

Additional Inherited Members

- Protected Member Functions inherited from Preprocessor
 cacheSetTree ($text, $flags, $tree)
 
 cacheGetTree ($text, $flags)
 
- Protected Attributes inherited from Preprocessor
 $rules
 

Member Function Documentation

Preprocessor_DOM::memCheck ( )
Exceptions
MWException
Returns
bool
Preprocessor_DOM::newCustomFrame (   $args)
Parameters
array$args
Returns
PPCustomFrame_DOM
Preprocessor_DOM::newFrame ( )
Returns
PPFrame_DOM
Preprocessor_DOM::newPartNodeArray (   $values)
Parameters
array$values
Returns
PPNode_DOM
Exceptions
MWException
Preprocessor_DOM::preprocessToObj (   $text,
  $flags = 0 
)

Preprocess some wikitext and return the document tree. This is the ghost of Parser::replace_variables().

Parameters
string$textThe text to parse
int$flagsBitwise combination of: Parser::PTD_FOR_INCLUSION Handle "<noinclude>" and "<includeonly>" as if the text is being included. Default is to assume a direct page view.

The generated DOM tree must depend only on the input text and the flags. The DOM tree must be the same in OT_HTML and OT_WIKI mode, to avoid a regression of T6899.

Any flag added to the $flags parameter here, or any other parameter liable to cause a change in the DOM tree for a given text, must be passed through the section identifier in the section edit link and thus back to extractSections().

The output of this function is currently only cached in process memory, but a persistent cache may be implemented at a later date which takes further advantage of these strict dependency requirements.

Exceptions
MWException
Returns
PPNode_DOM
Preprocessor_DOM::preprocessToXml (   $text,
  $flags = 0 
)
Parameters
string$text
int$flags
Returns
string

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