Manual:PPFrame.php

MediaWiki file: PPFrame.php
Location:	includes/parser/
Source code:	master • 1.42.3 • 1.41.4 • 1.39.10
Classes:	PPFrame

Object interface to provide an expansion frame for parsing wikitext.

Instantiation

• Preprocessor::newFrame()
• Preprocessor::newCustomFrame()

Constants

• NO_TEMPLATES
• STRIP_COMMENTS
• NO_IGNORE
• RECOVER_COMMENTS
• NO_TAGS
• PROCESS_NOWIKI
• RECOVER_ORIG
• NO_ARGS

Public methods

• newChild() - create a child frame.

Expansion methods

• expand() - expand a document tree node
• cachedExpand() - expand a document tree node, caching the result on its parent with the given key.

Implosion methods

• implode() - implode with no flags specified.
• implodeWithFlags() - implode with the flags for expand().
• virtualImplode() - create an object that when expanded, will be the same as one obtained with implode().
• virtualBracketedImplode() - virtual implode with brackets.

Methods for retrieving arguments

• isEmpty() - return true if there are no arguments in this frame.
• getArguments() - return all arguments of this frame.
• getNumberedArguments() - return all numbered arguments of this frame.
• getNamedArguments() - returns all named arguments of this frame.
• getArgument() - get an argument to this frame by name.

Other

• loopCheck() - returns true if the infinite loop check is OK, false if a loop is detected.
• isTemplate() - true if the frame is a template frame
• setVolatile() - get the "volatile" flag to mark it as unsuitable for caching the result of an expansion.
• isVolatile()
• getTTL() - get TTL (Time To Live) for browser cache
• setTTL()
• getTitle() - get a title of frame.

See also

• Parsing
• Manual:Parser functions
• Manual:PPFrame Hash.php