MediaWiki  1.28.1
PPFrame_DOM Class Reference

An expansion frame, used as a context to expand the result of preprocessToObj() More...

Inheritance diagram for PPFrame_DOM:
Collaboration diagram for PPFrame_DOM:

Public Member Functions

 __construct ($preprocessor)
 Construct a new preprocessor frame. More...
 
 __toString ()
 
 cachedExpand ($key, $root, $flags=0)
 
 expand ($root, $flags=0)
 
 getArgument ($name)
 
 getArguments ()
 
 getNamedArguments ()
 
 getNumberedArguments ()
 
 getPDBK ($level=false)
 
 getTitle ()
 Get a title of frame. More...
 
 getTTL ()
 Get the TTL. More...
 
 implode ($sep)
 Implode with no flags specified This previously called implodeWithFlags but has now been inlined to reduce stack depth. More...
 
 implodeWithFlags ($sep, $flags)
 
 isEmpty ()
 Returns true if there are no arguments in this frame. More...
 
 isTemplate ()
 Return true if the frame is a template frame. More...
 
 isVolatile ()
 Get the volatile flag. More...
 
 loopCheck ($title)
 Returns true if the infinite loop check is OK, false if a loop is detected. More...
 
 newChild ($args=false, $title=false, $indexOffset=0)
 Create a new child frame $args is optionally a multi-root PPNode or array containing the template arguments. More...
 
 setTTL ($ttl)
 Set the TTL. More...
 
 setVolatile ($flag=true)
 Set the volatile flag. More...
 
 virtualBracketedImplode ($start, $sep, $end)
 Virtual implode with brackets. More...
 
 virtualImplode ($sep)
 Makes an object that, when expand()ed, will be the same as one obtained with implode() More...
 

Public Attributes

 $depth
 Recursion depth of this frame, top = 0 Note that this is NOT the same as expansion depth in expand() More...
 
 $loopCheckHash
 Hashtable listing templates which are disallowed for expansion in this frame, having been encountered previously in parent frames. More...
 
Parser $parser
 
Preprocessor $preprocessor
 
Title $title
 
 $titleCache
 
- Public Attributes inherited from PPFrame
const NO_ARGS = 1
 
const NO_IGNORE = 8
 
const NO_TAGS = 32
 
const NO_TEMPLATES = 2
 
const RECOVER_COMMENTS = 16
 
const RECOVER_ORIG = 59
 
const STRIP_COMMENTS = 4
 
const SUPPORTS_INDEX_OFFSET = 1
 This constant exists when $indexOffset is supported in newChild() More...
 

Protected Attributes

array $childExpansionCache
 

Private Attributes

 $ttl = null
 
 $volatile = false
 

Detailed Description

An expansion frame, used as a context to expand the result of preprocessToObj()

Definition at line 942 of file Preprocessor_DOM.php.

Constructor & Destructor Documentation

PPFrame_DOM::__construct (   $preprocessor)

Construct a new preprocessor frame.

Parameters
Preprocessor$preprocessorThe parent preprocessor

Definition at line 985 of file Preprocessor_DOM.php.

References $preprocessor, false, and title.

Member Function Documentation

PPFrame_DOM::__toString ( )

Definition at line 1438 of file Preprocessor_DOM.php.

PPFrame_DOM::cachedExpand (   $key,
  $root,
  $flags = 0 
)
Exceptions
MWException
Parameters
string | int$key
string | PPNode_DOM | DOMDocument$root
int$flags
Returns
string

Implements PPFrame.

Definition at line 1063 of file Preprocessor_DOM.php.

References $flags, and expand().

PPFrame_DOM::expand (   $root,
  $flags = 0 
)
PPFrame_DOM::getArgument (   $name)
Parameters
int | string$name
Returns
bool Always false in this implementation.

Implements PPFrame.

Definition at line 1484 of file Preprocessor_DOM.php.

PPFrame_DOM::getArguments ( )
Returns
array

Implements PPFrame.

Definition at line 1453 of file Preprocessor_DOM.php.

PPFrame_DOM::getNamedArguments ( )
Returns
array

Implements PPFrame.

Definition at line 1467 of file Preprocessor_DOM.php.

PPFrame_DOM::getNumberedArguments ( )
Returns
array

Implements PPFrame.

Definition at line 1460 of file Preprocessor_DOM.php.

PPFrame_DOM::getPDBK (   $level = false)

Definition at line 1442 of file Preprocessor_DOM.php.

References title.

PPFrame_DOM::getTitle ( )

Get a title of frame.

Returns
Title

Implements PPFrame.

Definition at line 1512 of file Preprocessor_DOM.php.

References $title.

PPFrame_DOM::getTTL ( )

Get the TTL.

Returns
int|null

Implements PPFrame.

Definition at line 1550 of file Preprocessor_DOM.php.

References $ttl.

PPFrame_DOM::implode (   $sep)

Implode with no flags specified This previously called implodeWithFlags but has now been inlined to reduce stack depth.

Parameters
string$sep
string | PPNode_DOM | DOMDocument$args,...
Returns
string

Implements PPFrame.

Definition at line 1349 of file Preprocessor_DOM.php.

References $args, $s, as, and expand().

PPFrame_DOM::implodeWithFlags (   $sep,
  $flags 
)
Parameters
string$sep
int$flags
string | PPNode_DOM | DOMDocument$args,...
Returns
string

Implements PPFrame.

Definition at line 1317 of file Preprocessor_DOM.php.

References $args, $flags, $s, as, and expand().

PPFrame_DOM::isEmpty ( )

Returns true if there are no arguments in this frame.

Returns
bool

Implements PPFrame.

Definition at line 1476 of file Preprocessor_DOM.php.

PPFrame_DOM::isTemplate ( )

Return true if the frame is a template frame.

Returns
bool

Implements PPFrame.

Definition at line 1503 of file Preprocessor_DOM.php.

PPFrame_DOM::isVolatile ( )

Get the volatile flag.

Returns
bool

Implements PPFrame.

Definition at line 1530 of file Preprocessor_DOM.php.

References $volatile.

Referenced by PPTemplateFrame_DOM\cachedExpand().

PPFrame_DOM::loopCheck (   $title)

Returns true if the infinite loop check is OK, false if a loop is detected.

Parameters
Title$title
Returns
bool

Implements PPFrame.

Definition at line 1494 of file Preprocessor_DOM.php.

References Title\getPrefixedDBkey().

PPFrame_DOM::newChild (   $args = false,
  $title = false,
  $indexOffset = 0 
)

Create a new child frame $args is optionally a multi-root PPNode or array containing the template arguments.

Parameters
bool | array$args
Title | bool$title
int$indexOffset
Returns
PPTemplateFrame_DOM

Implements PPFrame.

Definition at line 1004 of file Preprocessor_DOM.php.

References $args, $name, $title, $value, as, expand(), PPFrame\STRIP_COMMENTS, text, title, wfEscapeWikiText(), and wfMessage().

PPFrame_DOM::setTTL (   $ttl)

Set the TTL.

Parameters
int$ttl

Implements PPFrame.

Definition at line 1539 of file Preprocessor_DOM.php.

References $ttl.

PPFrame_DOM::setVolatile (   $flag = true)

Set the volatile flag.

Parameters
bool$flag

Implements PPFrame.

Definition at line 1521 of file Preprocessor_DOM.php.

PPFrame_DOM::virtualBracketedImplode (   $start,
  $sep,
  $end 
)

Virtual implode with brackets.

Parameters
string$start
string$sep
string$end
string | PPNode_DOM | DOMDocument$args,...
Returns
array

Implements PPFrame.

Definition at line 1413 of file Preprocessor_DOM.php.

References $args, $out, and as.

Referenced by expand().

PPFrame_DOM::virtualImplode (   $sep)

Makes an object that, when expand()ed, will be the same as one obtained with implode()

Parameters
string$sep
string | PPNode_DOM | DOMDocument$args,...
Returns
array

Implements PPFrame.

Definition at line 1381 of file Preprocessor_DOM.php.

References $args, $out, and as.

Member Data Documentation

array PPFrame_DOM::$childExpansionCache
protected

Definition at line 979 of file Preprocessor_DOM.php.

PPFrame_DOM::$depth

Recursion depth of this frame, top = 0 Note that this is NOT the same as expansion depth in expand()

Definition at line 971 of file Preprocessor_DOM.php.

PPFrame_DOM::$loopCheckHash

Hashtable listing templates which are disallowed for expansion in this frame, having been encountered previously in parent frames.

Definition at line 965 of file Preprocessor_DOM.php.

Parser PPFrame_DOM::$parser

Definition at line 953 of file Preprocessor_DOM.php.

Preprocessor PPFrame_DOM::$preprocessor
Title PPFrame_DOM::$title

Definition at line 958 of file Preprocessor_DOM.php.

Referenced by PPTemplateFrame_DOM\__construct(), getTitle(), and newChild().

PPFrame_DOM::$titleCache

Definition at line 959 of file Preprocessor_DOM.php.

PPFrame_DOM::$ttl = null
private

Definition at line 974 of file Preprocessor_DOM.php.

Referenced by getTTL(), setTTL(), and PPTemplateFrame_DOM\setTTL().

PPFrame_DOM::$volatile = false
private

Definition at line 973 of file Preprocessor_DOM.php.

Referenced by isVolatile().


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