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

Public Member Functions

 __construct ($preprocessor, $parent=false, $numberedArgs=[], $namedArgs=[], $title=false)
 
 __toString ()
 
 cachedExpand ($key, $root, $flags=0)
 
 isEmpty ()
 
 getArguments ()
 
 getNumberedArguments ()
 
 getNamedArguments ()
 
 getNumberedArgument ($index)
 
 getNamedArgument ($name)
 
 getArgument ($name)
 
 isTemplate ()
 
 setVolatile ($flag=true)
 
 setTTL ($ttl)
 
- Public Member Functions inherited from PPFrame_DOM
 __construct ($preprocessor)
 
 newChild ($args=false, $title=false, $indexOffset=0)
 
 cachedExpand ($key, $root, $flags=0)
 
 expand ($root, $flags=0)
 
 implodeWithFlags ($sep, $flags)
 
 implode ($sep)
 
 virtualImplode ($sep)
 
 virtualBracketedImplode ($start, $sep, $end)
 
 __toString ()
 
 getPDBK ($level=false)
 
 getArguments ()
 
 getNumberedArguments ()
 
 getNamedArguments ()
 
 isEmpty ()
 
 getArgument ($name)
 
 loopCheck ($title)
 
 isTemplate ()
 
 getTitle ()
 
 setVolatile ($flag=true)
 
 isVolatile ()
 
 setTTL ($ttl)
 
 getTTL ()
 

Public Attributes

 $numberedArgs
 
 $namedArgs
 
 $parent
 
 $numberedExpansionCache
 
 $namedExpansionCache
 
- Public Attributes inherited from PPFrame_DOM
 $preprocessor
 
 $parser
 
 $title
 
 $titleCache
 
 $loopCheckHash
 
 $depth
 
- Public Attributes inherited from PPFrame
const NO_ARGS = 1
 
const NO_TEMPLATES = 2
 
const STRIP_COMMENTS = 4
 
const NO_IGNORE = 8
 
const RECOVER_COMMENTS = 16
 
const NO_TAGS = 32
 
const RECOVER_ORIG = 59
 
const SUPPORTS_INDEX_OFFSET = 1
 

Additional Inherited Members

- Protected Attributes inherited from PPFrame_DOM
 $childExpansionCache
 

Detailed Description

Expansion frame with template arguments

Constructor & Destructor Documentation

PPTemplateFrame_DOM::__construct (   $preprocessor,
  $parent = false,
  $numberedArgs = [],
  $namedArgs = [],
  $title = false 
)
Parameters
Preprocessor$preprocessor
bool | PPFrame_DOM$parent
array$numberedArgs
array$namedArgs
bool | Title$title

Member Function Documentation

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

Implements PPFrame.

PPTemplateFrame_DOM::getArgument (   $name)
Parameters
int | string$name
Returns
string|bool

Implements PPFrame.

PPTemplateFrame_DOM::getArguments ( )

Returns all arguments of this frame

Returns
array

Implements PPFrame.

PPTemplateFrame_DOM::getNamedArgument (   $name)
Parameters
string$name
Returns
string|bool
PPTemplateFrame_DOM::getNamedArguments ( )

Returns all named arguments of this frame

Returns
array

Implements PPFrame.

PPTemplateFrame_DOM::getNumberedArgument (   $index)
Parameters
int$index
Returns
string|bool
PPTemplateFrame_DOM::getNumberedArguments ( )

Returns all numbered arguments of this frame

Returns
array

Implements PPFrame.

PPTemplateFrame_DOM::isEmpty ( )

Returns true if there are no arguments in this frame

Returns
bool

Implements PPFrame.

PPTemplateFrame_DOM::isTemplate ( )

Return true if the frame is a template frame

Returns
bool

Implements PPFrame.

PPTemplateFrame_DOM::setTTL (   $ttl)

Set the TTL of the output of this frame and all of its ancestors. Has no effect if the new TTL is greater than the one already set. Note that it is the caller's responsibility to change the cache expiry of the page as a whole, if such behavior is desired.

See Also
self::getTTL()
Parameters
int$ttl

Implements PPFrame.

PPTemplateFrame_DOM::setVolatile (   $flag = true)

Set the "volatile" flag.

Note that this is somewhat of a "hack" in order to make extensions with side effects (such as Cite) work with the PHP parser. New extensions should be written in a way that they do not need this function, because other parsers (such as Parsoid) are not guaranteed to respect it, and it may be removed in the future.

Parameters
bool$flag

Implements PPFrame.


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