MediaWiki  REL1_31
PPFrame_Hash Class Reference

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

Inheritance diagram for PPFrame_Hash:
Collaboration diagram for PPFrame_Hash:

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 885 of file Preprocessor_Hash.php.

Constructor & Destructor Documentation

◆ __construct()

PPFrame_Hash::__construct (   $preprocessor)

Construct a new preprocessor frame.

Parameters
Preprocessor$preprocessorThe parent preprocessor

Definition at line 927 of file Preprocessor_Hash.php.

Member Function Documentation

◆ __toString()

PPFrame_Hash::__toString ( )

Reimplemented in PPCustomFrame_Hash, and PPTemplateFrame_Hash.

Definition at line 1357 of file Preprocessor_Hash.php.

◆ cachedExpand()

PPFrame_Hash::cachedExpand (   $key,
  $root,
  $flags = 0 
)
Exceptions
MWException
Parameters
string | int$key
string | PPNode$root
int$flags
Returns
string

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash.

Definition at line 998 of file Preprocessor_Hash.php.

◆ expand()

PPFrame_Hash::expand (   $root,
  $flags = 0 
)
Exceptions
MWException
Parameters
string | PPNode$root
int$flags
Returns
string

Implements PPFrame.

Definition at line 1009 of file Preprocessor_Hash.php.

◆ getArgument()

PPFrame_Hash::getArgument (   $name)
Parameters
int | string$name
Returns
bool Always false in this implementation.

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash, and PPCustomFrame_Hash.

Definition at line 1407 of file Preprocessor_Hash.php.

◆ getArguments()

PPFrame_Hash::getArguments ( )
Returns
array

Implements PPFrame.

Reimplemented in PPCustomFrame_Hash, and PPTemplateFrame_Hash.

Definition at line 1376 of file Preprocessor_Hash.php.

◆ getNamedArguments()

PPFrame_Hash::getNamedArguments ( )
Returns
array

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash.

Definition at line 1390 of file Preprocessor_Hash.php.

◆ getNumberedArguments()

PPFrame_Hash::getNumberedArguments ( )
Returns
array

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash.

Definition at line 1383 of file Preprocessor_Hash.php.

◆ getPDBK()

PPFrame_Hash::getPDBK (   $level = false)
Parameters
bool$level
Returns
array|bool|string

Definition at line 1365 of file Preprocessor_Hash.php.

◆ getTitle()

PPFrame_Hash::getTitle ( )

Get a title of frame.

Returns
Title

Implements PPFrame.

Definition at line 1436 of file Preprocessor_Hash.php.

◆ getTTL()

PPFrame_Hash::getTTL ( )

Get the TTL.

Returns
int|null

Implements PPFrame.

Definition at line 1474 of file Preprocessor_Hash.php.

◆ implode()

PPFrame_Hash::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$args,...
Returns
string

Implements PPFrame.

Definition at line 1267 of file Preprocessor_Hash.php.

◆ implodeWithFlags()

PPFrame_Hash::implodeWithFlags (   $sep,
  $flags 
)
Parameters
string$sep
int$flags
string | PPNode$args,...
Returns
string

Implements PPFrame.

Definition at line 1236 of file Preprocessor_Hash.php.

◆ isEmpty()

PPFrame_Hash::isEmpty ( )

Returns true if there are no arguments in this frame.

Returns
bool

Implements PPFrame.

Reimplemented in PPCustomFrame_Hash, and PPTemplateFrame_Hash.

Definition at line 1399 of file Preprocessor_Hash.php.

◆ isTemplate()

PPFrame_Hash::isTemplate ( )

Return true if the frame is a template frame.

Returns
bool

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash.

Definition at line 1427 of file Preprocessor_Hash.php.

◆ isVolatile()

PPFrame_Hash::isVolatile ( )

Get the volatile flag.

Returns
bool

Implements PPFrame.

Definition at line 1454 of file Preprocessor_Hash.php.

◆ loopCheck()

PPFrame_Hash::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 1418 of file Preprocessor_Hash.php.

◆ newChild()

PPFrame_Hash::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
array | bool | PPNode_Hash_Array$args
Title | bool$title
int$indexOffset
Exceptions
MWException
Returns
PPTemplateFrame_Hash

Implements PPFrame.

Definition at line 947 of file Preprocessor_Hash.php.

◆ setTTL()

PPFrame_Hash::setTTL (   $ttl)

Set the TTL.

Parameters
int$ttl

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash.

Definition at line 1463 of file Preprocessor_Hash.php.

◆ setVolatile()

PPFrame_Hash::setVolatile (   $flag = true)

Set the volatile flag.

Parameters
bool$flag

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash.

Definition at line 1445 of file Preprocessor_Hash.php.

◆ virtualBracketedImplode()

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

Virtual implode with brackets.

Parameters
string$start
string$sep
string$end
string | PPNode$args,...
Returns
PPNode_Hash_Array

Implements PPFrame.

Definition at line 1332 of file Preprocessor_Hash.php.

◆ virtualImplode()

PPFrame_Hash::virtualImplode (   $sep)

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

Parameters
string$sep
string | PPNode$args,...
Returns
PPNode_Hash_Array

Implements PPFrame.

Definition at line 1299 of file Preprocessor_Hash.php.

Member Data Documentation

◆ $childExpansionCache

array PPFrame_Hash::$childExpansionCache
protected

Definition at line 921 of file Preprocessor_Hash.php.

◆ $depth

PPFrame_Hash::$depth

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

Definition at line 913 of file Preprocessor_Hash.php.

◆ $loopCheckHash

PPFrame_Hash::$loopCheckHash

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

Definition at line 907 of file Preprocessor_Hash.php.

◆ $parser

Parser PPFrame_Hash::$parser

Definition at line 890 of file Preprocessor_Hash.php.

◆ $preprocessor

Preprocessor PPFrame_Hash::$preprocessor

Definition at line 895 of file Preprocessor_Hash.php.

◆ $title

Title PPFrame_Hash::$title

Definition at line 900 of file Preprocessor_Hash.php.

◆ $titleCache

PPFrame_Hash::$titleCache

Definition at line 901 of file Preprocessor_Hash.php.

◆ $ttl

PPFrame_Hash::$ttl = null
private

Definition at line 916 of file Preprocessor_Hash.php.

◆ $volatile

PPFrame_Hash::$volatile = false
private

Definition at line 915 of file Preprocessor_Hash.php.


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