MediaWiki  1.23.8
Preprocessor_DOM Class Reference
Inheritance diagram for Preprocessor_DOM:
Collaboration diagram for Preprocessor_DOM:

Public Member Functions

 __construct ( $parser)
 Create a new preprocessor object based on an initialised Parser object. More...
 
 memCheck ()
 
 newCustomFrame ( $args)
 
 newFrame ()
 
 newPartNodeArray ( $values)
 
 preprocessToObj ( $text, $flags=0)
 Preprocess some wikitext and return the document tree. More...
 
 preprocessToXml ( $text, $flags=0)
 

Public Attributes

 $memoryLimit
 
Parser $parser
 
const CACHE_VERSION = 1
 

Detailed Description

Definition at line 27 of file Preprocessor_DOM.php.

Constructor & Destructor Documentation

◆ __construct()

Preprocessor_DOM::__construct (   $parser)

Create a new preprocessor object based on an initialised Parser object.

Parameters
$parserParser

Implements Preprocessor.

Definition at line 37 of file Preprocessor_DOM.php.

References $parser.

Member Function Documentation

◆ memCheck()

Preprocessor_DOM::memCheck ( )
Exceptions
MWException
Returns
bool

Definition at line 95 of file Preprocessor_DOM.php.

References $limit.

◆ newCustomFrame()

Preprocessor_DOM::newCustomFrame (   $args)
Parameters
$argsarray
Returns
PPCustomFrame_DOM

Implements Preprocessor.

Definition at line 61 of file Preprocessor_DOM.php.

References $args.

◆ newFrame()

Preprocessor_DOM::newFrame ( )
Returns
PPFrame_DOM

Implements Preprocessor.

Definition at line 53 of file Preprocessor_DOM.php.

◆ newPartNodeArray()

Preprocessor_DOM::newPartNodeArray (   $values)
Parameters
$values
Returns
PPNode_DOM

Implements Preprocessor.

Definition at line 69 of file Preprocessor_DOM.php.

References as.

◆ preprocessToObj()

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
$flagsInteger: bitwise 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 bug 4899.

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

Implements Preprocessor.

Definition at line 130 of file Preprocessor_DOM.php.

References $flags, $version, $wgMemc, UtfNormal\cleanUp(), global, preprocessToXml(), wfDebugLog(), wfMemcKey(), wfProfileIn(), wfProfileOut(), wfRestoreWarnings(), and wfSuppressWarnings().

◆ preprocessToXml()

Preprocessor_DOM::preprocessToXml (   $text,
  $flags = 0 
)
Parameters
$textstring
$flagsint
Returns
string

Definition at line 207 of file Preprocessor_DOM.php.

References $flags, array(), and wfProfileIn().

Referenced by preprocessToObj().

Member Data Documentation

◆ $memoryLimit

Preprocessor_DOM::$memoryLimit

Definition at line 33 of file Preprocessor_DOM.php.

◆ $parser

Parser Preprocessor_DOM::$parser

Definition at line 31 of file Preprocessor_DOM.php.

Referenced by __construct().

◆ CACHE_VERSION

const Preprocessor_DOM::CACHE_VERSION = 1

Definition at line 35 of file Preprocessor_DOM.php.


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