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

Public Member Functions

 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)
 
 isEmpty ()
 
 getArguments ()
 
 getNumberedArguments ()
 
 getNamedArguments ()
 
 getArgument ($name)
 
 loopCheck ($title)
 
 isTemplate ()
 
 setVolatile ($flag=true)
 
 isVolatile ()
 
 getTTL ()
 
 setTTL ($ttl)
 
 getTitle ()
 

Public Attributes

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
 

Member Function Documentation

PPFrame::cachedExpand (   $key,
  $root,
  $flags = 0 
)

Expand a document tree node, caching the result on its parent with the given key

Parameters
string | int$key
string | PPNode$root
int$flags
Returns
string

Implemented in PPTemplateFrame_DOM, PPTemplateFrame_Hash, PPFrame_DOM, and PPFrame_Hash.

PPFrame::expand (   $root,
  $flags = 0 
)

Expand a document tree node

Parameters
string | PPNode$root
int$flags
Returns
string

Implemented in PPFrame_DOM, and PPFrame_Hash.

PPFrame::getArgument (   $name)

Get an argument to this frame by name

Parameters
int | string$name
Returns
string|bool

Implemented in PPCustomFrame_DOM, PPTemplateFrame_DOM, PPCustomFrame_Hash, PPTemplateFrame_Hash, PPFrame_DOM, and PPFrame_Hash.

PPFrame::getArguments ( )

Returns all arguments of this frame

Returns
array

Implemented in PPCustomFrame_DOM, PPTemplateFrame_DOM, PPCustomFrame_Hash, PPTemplateFrame_Hash, PPFrame_DOM, and PPFrame_Hash.

PPFrame::getNamedArguments ( )

Returns all named arguments of this frame

Returns
array

Implemented in PPTemplateFrame_DOM, PPTemplateFrame_Hash, PPFrame_DOM, and PPFrame_Hash.

PPFrame::getNumberedArguments ( )

Returns all numbered arguments of this frame

Returns
array

Implemented in PPTemplateFrame_DOM, PPTemplateFrame_Hash, PPFrame_DOM, and PPFrame_Hash.

PPFrame::getTitle ( )

Get a title of frame

Returns
Title

Implemented in PPFrame_DOM, and PPFrame_Hash.

PPFrame::getTTL ( )

Get the TTL of the frame's output.

This is the maximum amount of time, in seconds, that this frame's output should be cached for. A value of null indicates that no maximum has been specified.

Note that this TTL only applies to caching frames as parts of pages. It is not relevant to caching the entire rendered output of a page.

Returns
int|null

Implemented in PPFrame_DOM, and PPFrame_Hash.

PPFrame::implode (   $sep)

Implode with no flags specified

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

Implemented in PPFrame_DOM, and PPFrame_Hash.

PPFrame::implodeWithFlags (   $sep,
  $flags 
)

Implode with flags for expand()

Parameters
string$sep
int$flags
string | PPNode$args,...
Returns
string

Implemented in PPFrame_DOM, and PPFrame_Hash.

PPFrame::isEmpty ( )

Returns true if there are no arguments in this frame

Returns
bool

Implemented in PPCustomFrame_DOM, PPTemplateFrame_DOM, PPCustomFrame_Hash, PPFrame_DOM, PPTemplateFrame_Hash, and PPFrame_Hash.

PPFrame::isTemplate ( )

Return true if the frame is a template frame

Returns
bool

Implemented in PPTemplateFrame_DOM, PPTemplateFrame_Hash, PPFrame_DOM, and PPFrame_Hash.

PPFrame::isVolatile ( )

Get the "volatile" flag.

Callers should avoid caching the result of an expansion if it has the volatile flag set.

See Also
self::setVolatile()
Returns
bool

Implemented in PPFrame_DOM, and PPFrame_Hash.

PPFrame::loopCheck (   $title)

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

Parameters
Title$title
Returns
bool

Implemented in PPFrame_DOM, and PPFrame_Hash.

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

Create a child frame

Parameters
array | bool$args
bool | Title$title
int$indexOffsetA number subtracted from the index attributes of the arguments
Returns
PPFrame

Implemented in PPFrame_DOM, and PPFrame_Hash.

PPFrame::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

Implemented in PPTemplateFrame_DOM, PPTemplateFrame_Hash, PPFrame_DOM, and PPFrame_Hash.

PPFrame::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

Implemented in PPTemplateFrame_DOM, PPTemplateFrame_Hash, PPFrame_DOM, and PPFrame_Hash.

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

Virtual implode with brackets

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

Implemented in PPFrame_DOM, and PPFrame_Hash.

PPFrame::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

Implemented in PPFrame_DOM, and PPFrame_Hash.

Member Data Documentation

const PPFrame::SUPPORTS_INDEX_OFFSET = 1

This constant exists when $indexOffset is supported in newChild()


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