PHP Parser - Processes wiki markup (which uses a more user-friendly syntax, such as "[[link]]" for making links), and provides a one-way transformation of that wiki markup it into (X)HTML output / markup (which in turn the browser understands, and can display). More...

Collaboration diagram for Parser:

[legend]

List of all members.

Public Member Functions
	__clone ()
	Allow extensions to clean up when the parser is cloned.
	__construct ($conf=array())
	Constructor.
	__destruct ()
	Reduce memory usage to reduce the impact of circular references.
	addTrackingCategory ($msg)
	Add a tracking category, getting the title from a system message, or print a debug message if the title is invalid.
	areSubpagesAllowed ()
	Return true if subpage links should be expanded on this page.
	argSubstitution ($piece, $frame)
	Triple brace replacement -- used for template arguments.
	armorLinks ($text)
	Insert a NOPARSE hacky thing into any inline links in a chunk that's going to go through further parsing steps before inline URL expansion.
	attributeStripCallback (&$text, $frame=false)
	Callback from the Sanitizer for expanding items found in HTML attribute values, so they can be safely tested and escaped.
	braceSubstitution ($piece, $frame)
	Return the text of a template, after recursively replacing any variables or templates within the template.
	callParserFunction ($frame, $function, array $args=array())
	Call a parser function and return an array with text and flags.
	cleanSig ($text, $parsing=false)
	Clean up signature text.
	clearState ()
	Clear Parser state.
	clearTagHooks ()
	Remove all tag hooks.
	disableCache ()
	Set a flag in the output object indicating that the content is dynamic and shouldn't be cached.
	doAllQuotes ($text)
	Replace single quotes with HTML markup.
	doDoubleUnderscore ($text)
	Strip double-underscore items like __NOGALLERY__ and __NOTOC__ Fills $this->mDoubleUnderscores, returns the modified text.
	doHeadings ($text)
	Parse headers and return html.
	doMagicLinks ($text)
	Replace special strings like "ISBN xxx" and "RFC xxx" with magic external links.
	doQuotes ($text)
	Helper function for doAllQuotes()
	extensionSubstitution ($params, $frame)
	Return the text to be used for a given extension tag.
	fetchFile ($title, $options=array())
	Fetch a file and its title and register a reference to it.
	fetchFileAndTitle ($title, $options=array())
	Fetch a file and its title and register a reference to it.
	fetchScaryTemplateMaybeFromCache ($url)
	fetchTemplate ($title)
	Fetch the unparsed text of a template and register a reference to it.
	fetchTemplateAndTitle ($title)
	Fetch the unparsed text of a template and register a reference to it.
	findColonNoLinks ($str, &$before, &$after)
	Split up a string on ':', ignoring any occurrences inside tags to prevent illegal overlapping.
	firstCallInit ()
	Do various kinds of initialisation on the first call of the parser.
	getConverterLanguage ()
	Get the language object for language conversion.
	getCustomDefaultSort ()
	Accessor for $mDefaultSort Unlike getDefaultSort(), will return false if none is set.
	getDefaultSort ()
	Accessor for $mDefaultSort Will use the empty string if none is set.
	getExternalLinkAttribs ($url=false)
	Get an associative array of additional HTML attributes appropriate for a particular external link.
	getFunctionHooks ()
	Get all registered function hook identifiers.
	getFunctionLang ()
	Get a language object for use in parser functions such as {{FORMATNUM:}}.
	getImageParams ($handler)
	getOptions ()
	Get the ParserOptions object.
	getOutput ()
	Get the ParserOutput object.
	getPreloadText ($text, Title $title, ParserOptions $options)
	Process the wikitext for the "?preload=" feature.
	getPreprocessor ()
	Get a preprocessor object.
	getRevisionId ()
	Get the ID of the revision we are parsing.
	getRevisionSize ()
	Get the size of the revision.
	getRevisionTimestamp ()
	Get the timestamp associated with the current revision, adjusted for the default server-local timestamp.
	getRevisionUser ()
	Get the name of the user that edited the last revision.
	getSection ($text, $section, $deftext= '')
	This function returns the text of a section, specified by a number ($section).
	getStripList ()
	Get a list of strippable XML-like elements.
	getTags ()
	Accessor.
	getTargetLanguage ()
	Get the target language for the content being parsed.
	getTemplateDom ($title)
	Get the semi-parsed DOM representation of a template with a given title, and its redirect destination title.
	getTitle ()
	Accessor for the Title object.
	getUser ()
	Get a User object either from $this->mUser, if set, or from the ParserOptions object otherwise.
	getUserSig (&$user, $nickname=false, $fancySig=null)
	Fetch the user's signature text, if any, and normalize to validated, ready-to-insert wikitext.
	guessLegacySectionNameFromWikiText ($text)
	Same as guessSectionNameFromWikiText(), but produces legacy anchors instead.
	guessSectionNameFromWikiText ($text)
	Try to guess the section anchor name based on a wikitext fragment presumably extracted from a heading, for example "Header" from "== Header ==".
	incrementExpensiveFunctionCount ()
	Increment the expensive function count.
	incrementIncludeSize ($type, $size)
	Increment an include size counter.
	initialiseVariables ()
	initialise the magic variables (like CURRENTMONTHNAME) and substitution modifiers
	insertStripItem ($text)
	Add an item to the strip state Returns the unique tag which must be inserted into the stripped text The tag will be replaced with the original text in unstrip()
	interwikiTransclude ($title, $action)
	Transclude an interwiki link.
	isValidHalfParsedText ($data)
	Returns true if the given array, presumed to be generated by serializeHalfParsedText(), is compatible with the current version of the parser.
	killMarkers ($text)
	Remove any strip markers found in the given text.
	limitationWarn ($limitationType, $current= '', $max= '')
	Warn the user when a parser limitation is reached Will warn at most once the user per limitation type.
	magicLinkCallback ($m)
	makeFreeExternalLink ($url)
	Make a free external link, given a user-supplied URL.
	makeImage ($title, $options, $holders=false)
	Parse image options text and use it to make an image.
	makeKnownLinkHolder ($nt, $text= '', $query=array(), $trail= '', $prefix= '')
	Render a forced-blue link inline; protect against double expansion of URLs if we're in a mode that prepends full URL prefixes to internal links.
	markerSkipCallback ($s, $callback)
	Call a callback function on all regions of the given text that are not inside strip markers, and replace those regions with the return value of the callback.
	nextLinkID ()
	Options ($x=null)
	Accessor/mutator for the ParserOptions object.
	OutputType ($x=null)
	Accessor/mutator for the output type.
	parse ($text, Title $title, ParserOptions $options, $linestart=true, $clearState=true, $revid=null)
	Convert wikitext to HTML Do not call this function recursively.
	parseWidthParam ($value)
	Parsed a width param of imagelink like 300px or 200x300px.
	preprocess ($text, Title $title=null, ParserOptions $options, $revid=null)
	Expand templates and variables in the text, producing valid, static wikitext.
	preprocessToDom ($text, $flags=0)
	Preprocess some wikitext and return the document tree.
	preSaveTransform ($text, Title $title, User $user, ParserOptions $options, $clearState=true)
	Transform wiki markup when saving a page by doing "\r\n" -> "\n" conversion, substitting signatures, {{subst:}} templates, etc.
	pstPass2 ($text, $user)
	Pre-save transform helper function.
	recursivePreprocess ($text, $frame=false)
	Recursive parser entry point that can be called from an extension tag hook.
	recursiveTagParse ($text, $frame=false)
	Recursive parser entry point that can be called from an extension tag hook.
	renderImageGallery ($text, $params)
	Renders an image gallery from a text with one line per image.
	replaceExternalLinks ($text)
	Replace external links (REL)
	replaceInternalLinks ($s)
	Process [[ ]] wikilinks.
	replaceInternalLinks2 (&$s)
	Process [[ ]] wikilinks (RIL)
	replaceLinkHolders (&$text, $options=0)
	replaceLinkHoldersText ($text)
	Replace "<!--LINK-->" link placeholders with plain text of links (not HTML-formatted).
	replaceSection ($oldtext, $section, $text)
	This function returns $oldtext after the content of the section specified by $section has been replaced with $text.
	replaceTransparentTags ($text)
	Replace transparent tags in $text with the values given by the callbacks.
	replaceVariables ($text, $frame=false, $argsOnly=false)
	Replace magic variables, templates, and template arguments with the appropriate text.
	serializeHalfParsedText ($text)
	Save the parser state required to convert the given half-parsed text to HTML.
	setDefaultSort ($sort)
	Mutator for $mDefaultSort.
	setFunctionHook ($id, $callback, $flags=0)
	Create a function, e.g.
	setFunctionTagHook ($tag, $callback, $flags)
	Create a tag function, e.g.
	setHook ($tag, $callback)
	Create an HTML-style tag, e.g.
	setLinkID ($id)
	setOutputType ($ot)
	Set the output type.
	setTitle ($t)
	Set the context title.
	setTransparentTagHook ($tag, $callback)
	As setHook(), but letting the contents be parsed.
	setUser ($user)
	Set the current user.
	startExternalParse (Title $title=null, ParserOptions $options, $outputType, $clearState=true)
	Set up some variables which are usually set up in parse() so that an external function can call some class members with confidence.
	stripSectionName ($text)
	Strips a text string of wikitext for use in a section anchor.
	testPreprocess ($text, Title $title, ParserOptions $options)
	testPst ($text, Title $title, ParserOptions $options)
	testSrvus ($text, Title $title, ParserOptions $options, $outputType=self::OT_HTML)
	strip/replaceVariables/unstrip for preprocessor regression testing
	Title ($x=null)
	Accessor/mutator for the Title object.
	transformMsg ($text, $options, $title=null)
	Wrapper for preprocess()
	uniqPrefix ()
	Accessor for mUniqPrefix.
	unserializeHalfParsedText ($data)
	Load the parser state given in the $data array, which is assumed to have been generated by serializeHalfParsedText().
	validateSig ($text)
	Check that the user's signature contains no bad XML.
Static Public Member Functions
static	cleanSigInSig ($text)
	Strip ~~~, ~~~~ and ~~~~~ out of signatures.
static	createAssocArgs ($args)
	Clean up argument array - refactored in 1.9 so parserfunctions can use it, too.
static	extractTagsAndParams ($elements, $text, &$matches, $uniq_prefix= '')
	Replaces all occurrences of HTML-style comments and the given tags in the text with a random marker and returns the next text.
static	getExternalLinkRel ($url=false, $title=null)
	Get the rel attribute for a particular external link.
static	getRandomString ()
	Get a random string.
static	replaceUnusualEscapes ($url)
	Replace unusual URL escape codes with their equivalent characters.
static	splitWhitespace ($s)
	Return a three-element array: leading whitespace, string contents, trailing whitespace.
static	statelessFetchTemplate ($title, $parser=false)
	Static function to get a template Can be overridden via ParserOptions::setTemplateCallback().
Public Attributes
	$mArgStack
	$mAutonumber
	$mConf
	$mDefaultSort
	$mDefaultStripList = array()
	$mDoubleUnderscores
	$mDTopen
	$mExpensiveFunctionCount
	$mExtLinkBracketedRegex
	$mFirstCall = true
	$mForceTocPosition
	$mFunctionHooks = array()
	$mFunctionSynonyms = array( 0 => array(), 1 => array() )
	$mFunctionTagHooks = array()
	$mGeneratedPPNodeCount
	$mHeadings
	$mHighestExpansionDepth
	$mImageParams = array()
	$mImageParamsMagicArray = array()
	$mIncludeCount
	$mIncludeSizes
	$mInPre
	$mInputSize = false
Array	$mLangLinkLanguages
	with the language name of each language link (i.e.
	$mLastSection
LinkHolderArray	$mLinkHolders
	$mLinkID
	$mMarkerIndex = 0
ParserOptions	$mOptions
ParserOutput	$mOutput
	$mOutputType
	$mPPNodeCount
	$mPreprocessor
	$mRevIdForTs
	$mRevisionId
	$mRevisionObject
	$mRevisionSize
	$mRevisionTimestamp
	$mRevisionUser
	$mShowToc
	$mStripList = array()
StripState	$mStripState
MagicWordArray	$mSubstWords
	$mTagHooks = array()
Title	$mTitle
	$mTplDomCache
	$mTplExpandCache
	$mTplRedirCache
	$mTransparentTagHooks = array()
string	$mUniqPrefix
	$mUrlProtocols
User	$mUser
	$mVarCache = array()
MagicWordArray	$mVariables
	$ot
const	COLON_STATE_CLOSETAG = 3
const	COLON_STATE_COMMENT = 5
const	COLON_STATE_COMMENTDASH = 6
const	COLON_STATE_COMMENTDASHDASH = 7
const	COLON_STATE_TAG = 1
const	COLON_STATE_TAGSLASH = 4
const	COLON_STATE_TAGSTART = 2
const	COLON_STATE_TEXT = 0
const	EXT_IMAGE_REGEX
const	EXT_LINK_URL_CLASS = '[^][<>"\\x00-\\x20\\x7F\p{Zs}]'
const	HALF_PARSED_VERSION = 2
	Update this version number when the output of serialiseHalfParsedText() changes in an incompatible way.
const	MARKER_SUFFIX = "-QINU\x7f"
const	OT_HTML = 1
const	OT_MSG = 3
const	OT_PLAIN = 4
const	OT_PREPROCESS = 3
const	OT_WIKI = 2
const	PTD_FOR_INCLUSION = 1
const	SFH_NO_HASH = 1
const	SFH_OBJECT_ARGS = 2
const	TOC_END = '</mw:toc>'
const	TOC_START = '<mw:toc>'
const	VERSION = '1.6.4'
	Update this version number when the ParserOutput format changes in an incompatible way, so the parser cache can automatically discard old data.
Protected Member Functions
	fetchFileNoRegister ($title, $options=array())
	Helper function for fetchFileAndTitle.
	getRevisionObject ()
	Get the revision object for $this->mRevisionId.
	stripAltText ($caption, $holders)
Private Member Functions
	closeList ($char)
	TODO: document.
	closeParagraph ()
	#@+ Used by doBlockLevels()
	doBlockLevels ($text, $linestart)
	#@-
	doTableStuff ($text)
	parse the wiki syntax used to render tables
	extractSections ($text, $section, $mode, $newText= '')
	Break wikitext input into sections, and either pull or replace some particular section's text.
	formatHeadings ($text, $origText, $isMain=true)
	This function accomplishes several tasks: 1) Auto-number headings if that option is enabled 2) Add an [edit] link to sections for users who have enabled the option and can edit the page 3) Add a Table of contents on the top for users who have enabled the option 4) Auto-anchor headings.
	getCommon ($st1, $st2)
	getCommon() returns the length of the longest common substring of both arguments, starting at the beginning of both.
	getVariableValue ($index, $frame=false)
	Return value of a magic variable (like PAGENAME)
	internalParse ($text, $isMain=true, $frame=false)
	Helper function for parse() that transforms wiki markup into HTML.
	maybeDoSubpageLink ($target, &$text)
	Handle link to subpage if necessary.
	maybeMakeExternalImage ($url)
	make an image if it's allowed, either through the global option, through the exception, or through the on-wiki whitelist
	nextItem ($char)
	TODO: document.
	openList ($char)
	These next three functions open, continue, and close the list element appropriate to the prefix character passed into them.
	startParse (Title $title=null, ParserOptions $options, $outputType, $clearState=true)
Static Private Member Functions
static	replaceUnusualEscapesCallback ($matches)
	Callback function used in replaceUnusualEscapes().

Detailed Description

PHP Parser - Processes wiki markup (which uses a more user-friendly syntax, such as "[[link]]" for making links), and provides a one-way transformation of that wiki markup it into (X)HTML output / markup (which in turn the browser understands, and can display).

There are seven main entry points into the Parser class:

Parser::parse() produces HTML output
Parser::preSaveTransform(). produces altered wiki markup.
Parser::preprocess() removes HTML comments and expands templates
Parser::cleanSig() and Parser::cleanSigInSig() Cleans a signature before saving it to preferences
Parser::getSection() Return the content of a section from an article for section editing
Parser::replaceSection() Replaces a section by number inside an article
Parser::getPreloadText() Removes <noinclude> sections, and <includeonly> tags.

Globals used: object: $wgContLang

Warning:: $wgUser or $wgTitle or $wgRequest or $wgLang. Keep them away!

Settings:: $wgNamespacesWithSubpages

Settings only within ParserOptions:: $wgAllowExternalImages $wgAllowSpecialInclusion $wgInterwikiMagic $wgMaxArticleSize

Definition at line 67 of file Parser.php.

Constructor & Destructor Documentation

Parser::__construct ( $ conf = array() )

Constructor.

Parameters:

$conf array

Definition at line 209 of file Parser.php.

Parser::__destruct ( )

Reduce memory usage to reduce the impact of circular references.

Definition at line 234 of file Parser.php.

Member Function Documentation

Parser::__clone ( )

Allow extensions to clean up when the parser is cloned.

Definition at line 246 of file Parser.php.

Parser::addTrackingCategory ( $ msg )

Add a tracking category, getting the title from a system message, or print a debug message if the title is invalid.

Parameters:

string $msg message key

Returns:: Boolean: whether the addition was successful

Definition at line 4152 of file Parser.php.

Parser::areSubpagesAllowed ( )

Return true if subpage links should be expanded on this page.

Returns:: Boolean

Definition at line 2203 of file Parser.php.

Parser::argSubstitution	(	$	piece,
		$	frame
	)

Triple brace replacement -- used for template arguments.

Access:: private

Parameters:

$piece	array
$frame	PPFrame

Returns:: array

Definition at line 3928 of file Parser.php.

References $error, $ret, array(), wfProfileIn(), and wfProfileOut().

Parser::armorLinks ( $ text )

Insert a NOPARSE hacky thing into any inline links in a chunk that's going to go through further parsing steps before inline URL expansion.

Not needed quite as much as it used to be since free links are a bit more sensible these days. But bracketed links are still an issue.

Parameters:

string $text more-or-less HTML

Returns:: String: less-or-more HTML with NOPARSE bits

Definition at line 2194 of file Parser.php.

Parser::attributeStripCallback	(	&$	text,
		$	frame = `false`
	)

Callback from the Sanitizer for expanding items found in HTML attribute values, so they can be safely tested and escaped.

Parameters:

$text	String
$frame	PPFrame

Returns:: String

Definition at line 5528 of file Parser.php.

Parser::braceSubstitution	(	$	piece,
		$	frame
	)

Return the text of a template, after recursively replacing any variables or templates within the template.

Parameters:

array	$piece	the parts of the template $piece['title']: the title, i.e. the part before the \| $piece['parts']: the parameter array $piece['lineStart']: whether the brace was at the start of a line
	$frame	PPFrame The current frame, contains template arguments

Exceptions:

MWException

Returns:: String: the text of the template

Access:: private

Definition at line 3219 of file Parser.php.

Parser::callParserFunction	(	$	frame,
		$	function,
		array $	args = `array()`
	)

Call a parser function and return an array with text and flags.

The returned array will always contain a boolean 'found', indicating whether the parser function was found or not. It may also contain the following: text: string|object, resulting wikitext or PP DOM object isHTML: bool, $text is HTML, armour it against wikitext transformation isChildObj: bool, $text is a DOM node needing expansion in a child frame isLocalObj: bool, $text is a DOM node needing expansion in the current frame nowiki: bool, wiki markup in $text should be escaped

Since:: 1.21

Parameters:

$frame	PPFrame The current frame, contains template arguments
$function	string Function name
$args	array Arguments to the function

Returns:: array

Definition at line 3548 of file Parser.php.

Parser::cleanSig	(	$	text,
		$	parsing = `false`
	)

Clean up signature text.

1) Strip ~~~, ~~~~ and ~~~~~ out of signatures

See also:: cleanSigInSig 2) Substitute all transclusions

Parameters:

	$text	String
bool	$parsing	Whether we're cleaning (preferences save) or parsing

Returns:: String: signature text

Definition at line 4748 of file Parser.php.

static Parser::cleanSigInSig ( $ text ) [static]

Strip ~~~, ~~~~ and ~~~~~ out of signatures.

Parameters:

$text String

Returns:: String: signature text with /~{3,5}/ removed

Definition at line 4784 of file Parser.php.

Referenced by Preferences\cleanSignature(), and ExtraParserTest\testCleanSigInSig().

Parser::clearState ( )

Clear Parser state.

Access:: private

Definition at line 274 of file Parser.php.

Parser::clearTagHooks ( )

Remove all tag hooks.

Definition at line 4916 of file Parser.php.

Parser::closeList ( $ char ) [private]

TODO: document.

Parameters:

$char String

Returns:: string

Definition at line 2322 of file Parser.php.

Parser::closeParagraph ( ) [private]

#@+ Used by doBlockLevels()

Returns:: string

Definition at line 2226 of file Parser.php.

References Linker\normalizeSubpageLink().

static Parser::createAssocArgs ( $ args ) [static]

Clean up argument array - refactored in 1.9 so parserfunctions can use it, too.

Parameters:

$args array

Returns:: array

Definition at line 3152 of file Parser.php.

Parser::disableCache ( )

Set a flag in the output object indicating that the content is dynamic and shouldn't be cached.

Definition at line 5510 of file Parser.php.

Parser::doAllQuotes ( $ text )

Replace single quotes with HTML markup.

Access:: private

Parameters:

$text string

Returns:: string the altered text

Definition at line 1397 of file Parser.php.

Parser::doBlockLevels	(	$	text,
		$	linestart
	)		`[private]`

#@-

Make lists from lines starting with ':', '*', '#', etc. (DBL)

Parameters:

$text	String
$linestart	Boolean: whether or not this is at the start of a line.

Returns:: string the lists rendered as HTML

Definition at line 2349 of file Parser.php.

Parser::doDoubleUnderscore ( $ text )

Strip double-underscore items like __NOGALLERY__ and __NOTOC__ Fills $this->mDoubleUnderscores, returns the modified text.

Parameters:

$text string

Returns:: string

Definition at line 4094 of file Parser.php.

Parser::doHeadings ( $ text )

Parse headers and return html.

Access:: private

Parameters:

$text string

Returns:: string

Definition at line 1379 of file Parser.php.

References wfProfileIn(), and wfProfileOut().

Parser::doMagicLinks ( $ text )

Replace special strings like "ISBN xxx" and "RFC xxx" with magic external links.

DML

Access:: private

Parameters:

$text string

Returns:: string

Definition at line 1246 of file Parser.php.

Parser::doQuotes ( $ text )

Helper function for doAllQuotes()

Parameters:

$text string

Returns:: string

Definition at line 1416 of file Parser.php.

Parser::doTableStuff ( $ text ) [private]

parse the wiki syntax used to render tables

Returns:: string

Definition at line 976 of file Parser.php.

Parser::extensionSubstitution	(	$	params,
		$	frame
	)

Return the text to be used for a given extension tag.

This is the ghost of strip().

Parameters:

array	$params	Associative array of parameters: name PPNode for the tag name attr PPNode for unparsed text where tag attributes are thought to be attributes Optional associative array of parsed attributes inner Contents of extension element noClose Original text did not have a close tag
	$frame	PPFrame

Exceptions:

MWException

Returns:: string

Definition at line 3984 of file Parser.php.

Parser::extractSections	(	$	text,
		$	section,
		$	mode,
		$	newText = `''`
	)		`[private]`

Break wikitext input into sections, and either pull or replace some particular section's text.

External callers should use the getSection and replaceSection methods.

Parameters:

string	$text	Page wikitext
string	$section	a section identifier string of the form: "<flag1> - <flag2> - ... - <section number>"

Currently the only recognised flag is "T", which means the target section number was derived during a template inclusion parse, in other words this is a template section edit link. If no flags are given, it was an ordinary section edit link. This flag is required to avoid a section numbering mismatch when a section is enclosed by "<includeonly>" (bug 6563).

The section number 0 pulls the text before the first heading; other numbers will pull the given section along with its lower-level subsections. If the section is not found, $mode=get will return $newtext, and $mode=replace will return $text.

Section 0 is always considered to exist, even if it only contains the empty string. If $text is the empty string and section 0 is replaced, $newText is returned.

Parameters:

string	$mode	one of "get" or "replace"
string	$newText	replacement text for section data.

Returns:: String: for "get", the extracted section text. for "replace", the whole page with the section replaced.

Definition at line 5601 of file Parser.php.

static Parser::extractTagsAndParams	(	$	elements,
		$	text,
		&$	matches,
		$	uniq_prefix = `''`
	)		`[static]`

Replaces all occurrences of HTML-style comments and the given tags in the text with a random marker and returns the next text.

The output parameter $matches will be an associative array filled with data in the form:

   'UNIQ-xxxxx' => array(
     'element',
     'tag content',
     array( 'param' => 'x' ),
     '<element param="x">tag content</element>' ) )

Parameters:

array	$elements	list of element names. Comments are always extracted.
string	$text	Source text string.
array	$matches	Out parameter, Array: extracted tags
	$uniq_prefix	string

Returns:: String: stripped text

Definition at line 883 of file Parser.php.

Parser::fetchFile	(	$	title,
		$	options = `array()`
	)

Fetch a file and its title and register a reference to it.

If 'broken' is a key in $options then the file will appear as a broken thumbnail.

Parameters:

Title	$title
array	$options	Array of options to RepoGroup::findFile

Returns:: File|bool

Definition at line 3810 of file Parser.php.

Parser::fetchFileAndTitle	(	$	title,
		$	options = `array()`
	)

Fetch a file and its title and register a reference to it.

If 'broken' is a key in $options then the file will appear as a broken thumbnail.

Parameters:

Title	$title
array	$options	Array of options to RepoGroup::findFile

Returns:: Array ( File or false, Title of file )

Definition at line 3822 of file Parser.php.

Parser::fetchFileNoRegister	(	$	title,
		$	options = `array()`
	)		`[protected]`

Helper function for fetchFileAndTitle.

Also useful if you need to fetch a file but not use it yet, for example to get the file's handler.

Parameters:

Title	$title
array	$options	Array of options to RepoGroup::findFile

Returns:: File or false

Definition at line 3852 of file Parser.php.

Parser::fetchScaryTemplateMaybeFromCache ( $ url )

Parameters:

$url string

Returns:: Mixed|String

Definition at line 3890 of file Parser.php.

References wfMessage().

Parser::fetchTemplate ( $ title )

Fetch the unparsed text of a template and register a reference to it.

Parameters:

Title $title

Returns:: mixed string or false

Definition at line 3712 of file Parser.php.

Parser::fetchTemplateAndTitle ( $ title )

Fetch the unparsed text of a template and register a reference to it.

Parameters:

Title $title

Returns:: Array ( string or false, Title )

Definition at line 3689 of file Parser.php.

Parser::findColonNoLinks	(	$	str,
		&$	before,
		&$	after
	)

Split up a string on ':', ignoring any occurrences inside tags to prevent illegal overlapping.

Parameters:

string	$str	the string to split
	&$before	String set to everything before the ':'
	&$after	String set to everything after the ':'

Exceptions:

MWException

Returns:: String the position of the ':', or false if none found

Definition at line 2543 of file Parser.php.

Parser::firstCallInit ( )

Do various kinds of initialisation on the first call of the parser.

Definition at line 253 of file Parser.php.

Parser::formatHeadings	(	$	text,
		$	origText,
		$	isMain = `true`
	)		`[private]`

This function accomplishes several tasks: 1) Auto-number headings if that option is enabled 2) Add an [edit] link to sections for users who have enabled the option and can edit the page 3) Add a Table of contents on the top for users who have enabled the option 4) Auto-anchor headings.

It loops through all headlines, collects the necessary data, then splits up the string and re-inserts the newly formatted headlines.

Parameters:

	$text	String
string	$origText	original, untouched wikitext
	$isMain	Boolean

Returns:: mixed|string

Definition at line 4194 of file Parser.php.

Parser::getCommon	(	$	st1,
		$	st2
	)		`[private]`

getCommon() returns the length of the longest common substring of both arguments, starting at the beginning of both.

Parameters:

$st1	string
$st2	string

Returns:: int

Definition at line 2246 of file Parser.php.

Parser::getConverterLanguage ( )

Get the language object for language conversion.

Definition at line 833 of file Parser.php.

Parser::getCustomDefaultSort ( )

Accessor for $mDefaultSort Unlike getDefaultSort(), will return false if none is set.

Returns:: string or false

Definition at line 5867 of file Parser.php.

Parser::getDefaultSort ( )

Accessor for $mDefaultSort Will use the empty string if none is set.

This value is treated as a prefix, so the empty string is equivalent to sorting by page name.

Returns:: string

Definition at line 5853 of file Parser.php.

Parser::getExternalLinkAttribs ( $ url = false )

Get an associative array of additional HTML attributes appropriate for a particular external link.

This currently may include rel => nofollow (depending on configuration, namespace, and the URL's domain) and/or a target attribute (depending on configuration).

Parameters:

string | bool $url optional URL, to extract the domain from for rel => nofollow if appropriate

Returns:: Array associative array of HTML attributes

Definition at line 1706 of file Parser.php.

static Parser::getExternalLinkRel	(	$	url = `false`,
		$	title = `null`
	)		`[static]`

Get the rel attribute for a particular external link.

Since:: 1.21

Parameters:

string \| bool	$url	optional URL, to extract the domain from for rel => nofollow if appropriate
	$title	Title optional Title, for wgNoFollowNsExceptions lookups

Returns:: string|null rel attribute for $url

Definition at line 1686 of file Parser.php.

Referenced by Linker\makeExternalLink().

Parser::getFunctionHooks ( )

Get all registered function hook identifiers.

Returns:: Array

Definition at line 5003 of file Parser.php.

Parser::getFunctionLang ( )

Get a language object for use in parser functions such as {{FORMATNUM:}}.

Returns:: Language

Definition at line 803 of file Parser.php.

Parser::getImageParams ( $ handler )

Parameters:

$handler

Returns:: array

Definition at line 5231 of file Parser.php.

Parser::getOptions ( )

Get the ParserOptions object.

Returns:: ParserOptions object

Definition at line 771 of file Parser.php.

Parser::getOutput ( )

Get the ParserOutput object.

Returns:: ParserOutput object

Definition at line 762 of file Parser.php.

Parser::getPreloadText	(	$	text,
		Title $	title,
		ParserOptions $	options
	)

Process the wikitext for the "?preload=" feature.

(bug 5210)

"<noinclude>", "<includeonly>" etc. are parsed as for template transclusion, comments, templates, arguments, tags hooks and parser functions are untouched.

Parameters:

$text	String
$title	Title
$options	ParserOptions

Returns:: String

Definition at line 645 of file Parser.php.

Parser::getPreprocessor ( )

Get a preprocessor object.

Returns:: Preprocessor instance

Definition at line 855 of file Parser.php.

static Parser::getRandomString ( ) [static]

Get a random string.

Returns:: string

Definition at line 661 of file Parser.php.

Referenced by StripState\merge().

Parser::getRevisionId ( )

Get the ID of the revision we are parsing.

Returns:: Mixed: integer or null

Definition at line 5745 of file Parser.php.

Parser::getRevisionObject ( ) [protected]

Get the revision object for $this->mRevisionId.

Returns:: Revision|null either a Revision object or null

Definition at line 5754 of file Parser.php.

Parser::getRevisionSize ( )

Get the size of the revision.

Returns:: int|null revision size

Definition at line 5817 of file Parser.php.

Parser::getRevisionTimestamp ( )

Get the timestamp associated with the current revision, adjusted for the default server-local timestamp.

Definition at line 5770 of file Parser.php.

Parser::getRevisionUser ( )

Get the name of the user that edited the last revision.

Returns:: String: user name

Definition at line 5797 of file Parser.php.

Parser::getSection	(	$	text,
		$	section,
		$	deftext = `''`
	)

This function returns the text of a section, specified by a number ($section).

A section is text under a heading like == Heading == or <h1>Heading</h1>, or the first section before any such heading (section 0).

If a section contains subsections, these are also returned.

Parameters:

string	$text	text to look in
string	$section	section identifier
string	$deftext	default to return if section is not found

Returns:: string text of the requested section

Definition at line 5722 of file Parser.php.

Parser::getStripList ( )

Get a list of strippable XML-like elements.

Returns:: array

Definition at line 950 of file Parser.php.

Parser::getTags ( )

Accessor.

Returns:: array

Definition at line 5539 of file Parser.php.

Parser::getTargetLanguage ( )

Get the target language for the content being parsed.

This is usually the language that the content is in.

Since:: 1.19

Exceptions:

MWException

Returns:: Language|null

Definition at line 816 of file Parser.php.

Referenced by getUser().

Parser::getTemplateDom ( $ title )

Get the semi-parsed DOM representation of a template with a given title, and its redirect destination title.

Cached.

Parameters:

$title Title

Returns:: array

Definition at line 3652 of file Parser.php.

Parser::getTitle ( )

Accessor for the Title object.

Returns:: Title object

Definition at line 717 of file Parser.php.

Parser::getUser ( )

Get a User object either from $this->mUser, if set, or from the ParserOptions object otherwise.

Returns:: User object

Definition at line 843 of file Parser.php.

References getTargetLanguage().

Parser::getUserSig	(	&$	user,
		$	nickname = `false`,
		$	fancySig = `null`
	)

Fetch the user's signature text, if any, and normalize to validated, ready-to-insert wikitext.

If you have pre-fetched the nickname or the fancySig option, you can specify them here to save a database query. Do not reuse this parser instance after calling getUserSig(), as it may have changed if it's the $wgParser.

Parameters:

	$user	User
string \| bool	$nickname	nickname to use or false to use user's default nickname
	$fancySig	Boolean\|null whether the nicknname is the complete signature or null to use default value

Returns:: string

Definition at line 4686 of file Parser.php.

Parser::getVariableValue	(	$	index,
		$	frame = `false`
	)		`[private]`

Return value of a magic variable (like PAGENAME)

Parameters:

$index	integer
bool\|\PPFrame	$frame

Exceptions:

MWException

Returns:: string

Definition at line 2711 of file Parser.php.

Parser::guessLegacySectionNameFromWikiText ( $ text )

Same as guessSectionNameFromWikiText(), but produces legacy anchors instead.

For use in redirects, since IE6 interprets Redirect: headers as something other than UTF-8 (apparently?), resulting in breakage.

Parameters:

string $text The section name

Returns:: string An anchor

Definition at line 5895 of file Parser.php.

Parser::guessSectionNameFromWikiText ( $ text )

Try to guess the section anchor name based on a wikitext fragment presumably extracted from a heading, for example "Header" from "== Header ==".

Parameters:

$text string

Returns:: string

Definition at line 5880 of file Parser.php.

References Sanitizer\escapeId(), and Sanitizer\normalizeSectionNameWhitespace().

Parser::incrementExpensiveFunctionCount ( )

Increment the expensive function count.

Returns:: Boolean: false if the limit has been exceeded

Definition at line 4081 of file Parser.php.

Parser::incrementIncludeSize	(	$	type,
		$	size
	)

Increment an include size counter.

Parameters:

string	$type	the type of expansion
	$size	Integer: the size of the text

Returns:: Boolean: false if this inclusion would take it over the maximum, true otherwise

Definition at line 4067 of file Parser.php.

Parser::initialiseVariables ( )

initialise the magic variables (like CURRENTMONTHNAME) and substitution modifiers

Access:: private

Definition at line 3045 of file Parser.php.

Parser::insertStripItem ( $ text )

Add an item to the strip state Returns the unique tag which must be inserted into the stripped text The tag will be replaced with the original text in unstrip()

Parameters:

$text string

Returns:: string

Definition at line 963 of file Parser.php.

References MARKER_SUFFIX.

Parser::internalParse	(	$	text,
		$	isMain = `true`,
		$	frame = `false`
	)		`[private]`

Helper function for parse() that transforms wiki markup into HTML.

Only called for $mOutputType == self::OT_HTML.

Parameters:

$text	string
$isMain	bool
$frame	bool

Returns:: string

Definition at line 1178 of file Parser.php.

Parser::interwikiTransclude	(	$	title,
		$	action
	)

Transclude an interwiki link.

Parameters:

$title	Title
$action

Returns:: string

Definition at line 3871 of file Parser.php.

Parser::isValidHalfParsedText ( $ data )

Returns true if the given array, presumed to be generated by serializeHalfParsedText(), is compatible with the current version of the parser.

Parameters:

$data Array

Returns:: bool

Definition at line 6092 of file Parser.php.

Parser::killMarkers ( $ text )

Remove any strip markers found in the given text.

Parameters:

$text Input string

Returns:: string

Definition at line 6020 of file Parser.php.

Parser::limitationWarn	(	$	limitationType,
		$	current = `''`,
		$	max = `''`
	)

Warn the user when a parser limitation is reached Will warn at most once the user per limitation type.

Parameters:

string	$limitationType	should be one of: 'expensive-parserfunction' (corresponding messages: 'expensive-parserfunction-warning', 'expensive-parserfunction-category') 'post-expand-template-argument' (corresponding messages: 'post-expand-template-argument-warning', 'post-expand-template-argument-category') 'post-expand-template-inclusion' (corresponding messages: 'post-expand-template-inclusion-warning', 'post-expand-template-inclusion-category') 'node-count-exceeded' (corresponding messages: 'node-count-exceeded-warning', 'node-count-exceeded-category') 'expansion-depth-exceeded' (corresponding messages: 'expansion-depth-exceeded-warning', 'expansion-depth-exceeded-category')
int \| null	$current	Current value
int \| null	$max	Maximum allowed, when an explicit limit has been exceeded, provide the values (optional)

Definition at line 3198 of file Parser.php.

Parser::magicLinkCallback ( $ m )

Exceptions:

MWException

Parameters:

$m array

Returns:: HTML|string

Definition at line 1271 of file Parser.php.

Parser::makeFreeExternalLink ( $ url )

Make a free external link, given a user-supplied URL.

Parameters:

$url string

Returns:: string HTML

Access:: private

Definition at line 1324 of file Parser.php.

Parser::makeImage	(	$	title,
		$	options,
		$	holders = `false`
	)

Parse image options text and use it to make an image.

Parameters:

$title	Title
$options	String
$holders	LinkHolderArray\|bool

Returns:: string HTML

Definition at line 5279 of file Parser.php.

Parser::makeKnownLinkHolder	(	$	nt,
		$	text = `''`,
		$	query = `array()`,
		$	trail = `''`,
		$	prefix = `''`
	)

Render a forced-blue link inline; protect against double expansion of URLs if we're in a mode that prepends full URL prefixes to internal links.

Since this little disaster has to split off the trail text to avoid breaking URLs in the following text without breaking trails on the wiki links, it's been made into a horrible function.

Parameters:

	$nt	Title
	$text	String
array	$query	or String
	$trail	String
	$prefix	String

Returns:: String: HTML-wikitext mix oh yuck

Definition at line 2169 of file Parser.php.

Parser::markerSkipCallback	(	$	s,
		$	callback
	)

Call a callback function on all regions of the given text that are not inside strip markers, and replace those regions with the return value of the callback.

For example, with input:

aaa<MARKER>bbb

This will call the callback function twice, with 'aaa' and 'bbb'. Those two strings will be replaced with the value returned by the callback in each case.

Parameters:

$s	string
$callback

Returns:: string

Definition at line 5990 of file Parser.php.

Parser::maybeDoSubpageLink	(	$	target,
		&$	text
	)		`[private]`

Handle link to subpage if necessary.

Parameters:

string	$target	the source of the link
	&$text	String: the link text, modified as necessary

Returns:: string the full name of the link

Definition at line 2216 of file Parser.php.

Parser::maybeMakeExternalImage ( $ url ) [private]

make an image if it's allowed, either through the global option, through the exception, or through the on-wiki whitelist

$param $url string

Returns:: string

Definition at line 1762 of file Parser.php.

References as, empty, Linker\makeExternalImage(), text, and wfMessage().

Parser::nextItem ( $ char ) [private]

TODO: document.

Parameters:

$char String

Returns:: string

Definition at line 2296 of file Parser.php.

Parser::nextLinkID ( )

Returns:: int

Definition at line 788 of file Parser.php.

Parser::openList ( $ char ) [private]

These next three functions open, continue, and close the list element appropriate to the prefix character passed into them.

Parameters:

$char string

Returns:: string

Definition at line 2270 of file Parser.php.

References $result.

Parser::Options ( $ x = null )

Accessor/mutator for the ParserOptions object.

Parameters:

$x	ParserOptions New value or null to just get the current one

Returns:: ParserOptions Current ParserOptions object

Definition at line 781 of file Parser.php.

Parser::OutputType ( $ x = null )

Accessor/mutator for the output type.

Parameters:

int | null $x New value or null to just get the current one

Returns:: Integer

Definition at line 753 of file Parser.php.

Parser::parse	(	$	text,
		Title $	title,
		ParserOptions $	options,
		$	linestart = `true`,
		$	clearState = `true`,
		$	revid = `null`
	)

Convert wikitext to HTML Do not call this function recursively.

Parameters:

string	$text	text we want to parse
	$title	Title object
	$options	ParserOptions
	$linestart	boolean
	$clearState	boolean
int	$revid	number to pass in {{REVISIONID}}

Returns:: ParserOutput a ParserOutput

Definition at line 346 of file Parser.php.

Parser::parseWidthParam ( $ value )

Parsed a width param of imagelink like 300px or 200x300px.

Parameters:

$value String

Returns:: array

Since:: 1.20

Definition at line 6104 of file Parser.php.

Parser::preprocess	(	$	text,
		Title $	title = `null`,
		ParserOptions $	options,
		$	revid = `null`
	)

Expand templates and variables in the text, producing valid, static wikitext.

Also removes comments.

Returns:: mixed|string

Definition at line 602 of file Parser.php.

Parser::preprocessToDom	(	$	text,
		$	flags = `0`
	)

Preprocess some wikitext and return the document tree.

This is the ghost of replace_variables().

Parameters:

string	$text	The text to parse
	$flags	Integer: bitwise combination of: self::PTD_FOR_INCLUSION Handle "<noinclude>" and "<includeonly>" as if the text is being included. Default is to assume a direct page view.

The generated DOM tree must depend only on the input text and the flags. The DOM tree must be the same in OT_HTML and OT_WIKI mode, to avoid a regression of bug 4899.

Any flag added to the $flags parameter here, or any other parameter liable to cause a change in the DOM tree for a given text, must be passed through the section identifier in the section edit link and thus back to extractSections().

The output of this function is currently only cached in process memory, but a persistent cache may be implemented at a later date which takes further advantage of these strict dependency requirements.

Access:: private

Returns:: PPNode

Definition at line 3079 of file Parser.php.

Parser::preSaveTransform	(	$	text,
		Title $	title,
		User $	user,
		ParserOptions $	options,
		$	clearState = `true`
	)

Transform wiki markup when saving a page by doing "\r\n" -> "\n" conversion, substitting signatures, {{subst:}} templates, etc.

Parameters:

string	$text	the text to transform
	$title	Title: the Title object for the current article
	$user	User: the User object describing the current user
	$options	ParserOptions: parsing options
	$clearState	Boolean: whether to clear the parser state first

Returns:: String: the altered wiki markup

Definition at line 4575 of file Parser.php.

Parser::pstPass2	(	$	text,
		$	user
	)

Pre-save transform helper function.

Access:: private

Parameters:

$text	string
$user	User

Returns:: string

Definition at line 4602 of file Parser.php.

References $key, $t, $timestamp, $wgContLang, add, array(), from, MWTimestamp\getLocalInstance(), global, in, Title\legalChars(), on, page, title, and wfMessage().

Parser::recursivePreprocess	(	$	text,
		$	frame = `false`
	)

Recursive parser entry point that can be called from an extension tag hook.

Parameters:

string	$text	text to be expanded
	$frame	PPFrame: The frame to use for expanding any template variables

Returns:: String

Since:: 1.19

Definition at line 625 of file Parser.php.

References replaceVariables(), wfProfileIn(), and wfProfileOut().

Parser::recursiveTagParse	(	$	text,
		$	frame = `false`
	)

Recursive parser entry point that can be called from an extension tag hook.

If $frame is not provided, then template variables (e.g., {{{1}}}) within $text are not expanded

Parameters:

string	$text	text extension wants to have parsed
	$frame	PPFrame: The frame to use for expanding any template variables

Returns:: string

Definition at line 588 of file Parser.php.

Parser::renderImageGallery	(	$	text,
		$	params
	)

Renders an image gallery from a text with one line per image.

text labels may be given by using |-style alternative text. E.g. Image:one.jpg|The number "1" Image:tree.jpg|A tree given as text will return the HTML of a gallery with two images, labeled 'The number "1"' and 'A tree'.

Parameters:

string	$text
array	$params

Returns:: string HTML

Definition at line 5071 of file Parser.php.

Parser::replaceExternalLinks ( $ text )

Replace external links (REL)

Note: this is all very hackish and the order of execution matters a lot. Make sure to run tests/parserTests.php if you change this code.

Access:: private

Parameters:

$text string

Exceptions:

MWException

Returns:: string

Definition at line 1606 of file Parser.php.

Parser::replaceInternalLinks ( $ s )

Process [[ ]] wikilinks.

Parameters:

$s string

Returns:: String: processed text

Access:: private

Definition at line 1814 of file Parser.php.

References $s, and replaceInternalLinks2().

Parser::replaceInternalLinks2 ( &$ s )

Process [[ ]] wikilinks (RIL)

Parameters:

$s

Exceptions:

MWException

Returns:: LinkHolderArray

Access:: private

Definition at line 1827 of file Parser.php.

Referenced by replaceInternalLinks().

linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in Parser::replaceLinkHolders	(	&$	text,
		$	options = `0`
	)

Todo:: FIXME: Update documentation.

makeLinkObj() is deprecated. Replace "" link placeholders with actual links, in the buffer Placeholders created in Skin::makeLinkObj()

Parameters:

$text	string
$options	int

Returns:: array of link CSS classes, indexed by PDBK.

Definition at line 5043 of file Parser.php.

Parser::replaceLinkHoldersText ( $ text )

Replace "" link placeholders with plain text of links (not HTML-formatted).

Parameters:

$text String

Returns:: String

Definition at line 5054 of file Parser.php.

Parser::replaceSection	(	$	oldtext,
		$	section,
		$	text
	)

This function returns $oldtext after the content of the section specified by $section has been replaced with $text.

If the target section does not exist, $oldtext is returned unchanged.

Parameters:

string	$oldtext	former text of the article
int	$section	section identifier
string	$text	replacing text

Returns:: String: modified text

Definition at line 5736 of file Parser.php.

Parser::replaceTransparentTags ( $ text )

Replace transparent tags in $text with the values given by the callbacks.

Transparent tag hooks are like regular XML-style tag hooks, except they operate late in the transformation sequence, on HTML instead of wikitext.

Parameters:

$text string

Returns:: string

Definition at line 5553 of file Parser.php.

static Parser::replaceUnusualEscapes ( $ url ) [static]

Replace unusual URL escape codes with their equivalent characters.

Parameters:

$url String

Returns:: String

Todo:: This can merge genuinely required bits in the path or query string, breaking legit URLs. A proper fix would treat the various parts of the URL differently; as a workaround, just use the output for statistical records, not for actual linking/output.

Definition at line 1727 of file Parser.php.

static Parser::replaceUnusualEscapesCallback ( $ matches ) [static, private]

Callback function used in replaceUnusualEscapes().

Replaces unusual URL escape codes with their equivalent character

Parameters:

$matches array

Returns:: string

Definition at line 1740 of file Parser.php.

Parser::replaceVariables	(	$	text,
		$	frame = `false`,
		$	argsOnly = `false`
	)

Replace magic variables, templates, and template arguments with the appropriate text.

Templates are substituted recursively, taking care to avoid infinite loops.

Note that the substitution depends on value of $mOutputType: self::OT_WIKI: only {{subst:}} templates self::OT_PREPROCESS: templates but not extension tags self::OT_HTML: all templates and extension tags

Parameters:

string	$text	the text to transform
	$frame	PPFrame Object describing the arguments passed to the template. Arguments may also be provided as an associative array, as was the usual case before MW1.12. Providing arguments this way may be useful for extensions wishing to perform variable replacement explicitly.
	$argsOnly	Boolean only do argument (triple-brace) expansion, not double-brace expansion

Access:: private

Returns:: string

Definition at line 3123 of file Parser.php.

Referenced by recursivePreprocess().

Parser::serializeHalfParsedText ( $ text )

Save the parser state required to convert the given half-parsed text to HTML.

"Half-parsed" in this context means the output of recursiveTagParse() or internalParse(). This output has strip markers from replaceVariables (extensionSubstitution() etc.), and link placeholders from replaceLinkHolders().

Returns an array which can be serialized and stored persistently. This array can later be loaded into another parser instance with unserializeHalfParsedText(). The text can then be safely incorporated into the return value of a parser hook.

Parameters:

$text string

Returns:: array

Definition at line 6040 of file Parser.php.

Parser::setDefaultSort ( $ sort )

Mutator for $mDefaultSort.

Parameters:

string $sort New value

Definition at line 5838 of file Parser.php.

Parser::setFunctionHook	(	$	id,
		$	callback,
		$	flags = `0`
	)

Create a function, e.g.

{{sum:1|2|3}} The callback function should have the form: function myParserFunction( &$parser, $arg1, $arg2, $arg3 ) { ... }

Or with SFH_OBJECT_ARGS: function myParserFunction( $parser, $frame, $args ) { ... }

The callback may either return the text result of the function, or an array with the text in element 0, and a number of flags in the other elements. The names of the flags are specified in the keys. Valid flags are: found The text returned is valid, stop processing the template. This is on by default. nowiki Wiki markup in the return value should be escaped isHTML The returned text is HTML, armour it against wikitext transformation

Parameters:

string	$id	The magic word ID
	$callback	Mixed: the callback function (and object) to use
	$flags	Integer: a combination of the following flags: SFH_NO_HASH No leading hash, i.e. {{plural:...}} instead of {{if:...}}

SFH_OBJECT_ARGS Pass the template arguments as PPNode objects instead of text. This allows for conditional expansion of the parse tree, allowing you to eliminate dead branches and thus speed up parsing. It is also possible to analyse the parse tree of the arguments, and to control the way they are expanded.

The $frame parameter is a PPFrame. This can be used to produce expanded text from the arguments, for instance: $text = isset( $args[0] ) ? $frame->expand( $args[0] ) : '';

For technical reasons, $args[0] is pre-expanded and will be a string. This may change in future versions. Please call $frame->expand() on it anyway so that your code keeps working if/when this is changed.

If you want whitespace to be trimmed from $args, you need to do it yourself, post- expansion.

Please read the documentation in includes/parser/Preprocessor.php for more information about the methods available in PPFrame and PPNode.

Exceptions:

MWException

Returns:: string|callback The old callback function for this name, if any

Definition at line 4965 of file Parser.php.

Parser::setFunctionTagHook	(	$	tag,
		$	callback,
		$	flags
	)

Create a tag function, e.g.

"<test>some stuff</test>". Unlike tag hooks, tag functions are parsed at preprocessor level. Unlike parser functions, their content is not preprocessed.

Parameters:

$tag
$callback
$flags

Exceptions:

MWException

Returns:: null

Definition at line 5017 of file Parser.php.

Parser::setHook	(	$	tag,
		$	callback
	)

Create an HTML-style tag, e.g.

"<yourtag>special text</yourtag>" The callback should have the following form: function myParserHook( $text, $params, $parser, $frame ) { ... }

Transform and return $text. Use $parser for any required context, e.g. use $parser->getTitle() and $parser->getOptions() not $wgTitle or $wgOut->mParserOptions

Hooks may return extended information by returning an array, of which the first numbered element (index 0) must be the return string, and all other entries are extracted into local variables within an internal function in the Parser class.

This interface (introduced r61913) appears to be undocumented, but 'markerName' is used by some core tag hooks to override which strip array their results are placed in. **Use great caution if attempting this interface, as it is not documented and injudicious use could smash private variables.**

Parameters:

$tag	Mixed: the tag to use, e.g. 'hook' for "<hook>"
$callback	Mixed: the callback function (and object) to use for the tag

Exceptions:

MWException

Returns:: Mixed|null The old value of the mTagHooks array associated with the hook

Definition at line 4871 of file Parser.php.

Parser::setLinkID ( $ id )

Parameters:

$id int

Definition at line 795 of file Parser.php.

Parser::setOutputType ( $ ot )

Set the output type.

Parameters:

$ot	Integer: new value

Definition at line 736 of file Parser.php.

Parser::setTitle ( $ t )

Set the context title.

Parameters:

$t Title

Definition at line 698 of file Parser.php.

Parser::setTransparentTagHook	(	$	tag,
		$	callback
	)

As setHook(), but letting the contents be parsed.

Transparent tag hooks are like regular XML-style tag hooks, except they operate late in the transformation sequence, on HTML instead of wikitext.

This is probably obsoleted by things dealing with parser frames? The only extension currently using it is geoserver.

Since:: 1.10

Todo:: better document or deprecate this

Parameters:

$tag	Mixed: the tag to use, e.g. 'hook' for "<hook>"
$callback	Mixed: the callback function (and object) to use for the tag

Exceptions:

MWException

Returns:: Mixed|null The old value of the mTagHooks array associated with the hook

Definition at line 4902 of file Parser.php.

Parser::setUser ( $ user )

Set the current user.

Should only be used when doing pre-save transform.

Parameters:

$user Mixed: User object or null (to reset)

Definition at line 671 of file Parser.php.

References wfRandomString().

static Parser::splitWhitespace ( $ s ) [static]

Return a three-element array: leading whitespace, string contents, trailing whitespace.

Parameters:

$s string

Returns:: array

Definition at line 3091 of file Parser.php.

Parser::startExternalParse	(	Title $	title = `null`,
		ParserOptions $	options,
		$	outputType,
		$	clearState = `true`
	)

Set up some variables which are usually set up in parse() so that an external function can call some class members with confidence.

Parameters:

$title	Title\|null
$options	ParserOptions
$outputType
$clearState	bool

Definition at line 4798 of file Parser.php.

Parser::startParse	(	Title $	title = `null`,
		ParserOptions $	options,
		$	outputType,
		$	clearState = `true`
	)		`[private]`

Parameters:

$title	Title\|null
$options	ParserOptions
$outputType
$clearState	bool

Definition at line 4808 of file Parser.php.

static Parser::statelessFetchTemplate	(	$	title,
		$	parser = `false`
	)		`[static]`

Static function to get a template Can be overridden via ParserOptions::setTemplateCallback().

Parameters:

$title	Title
$parser	Parser

Returns:: array

Definition at line 3726 of file Parser.php.

References $parser, $rev, $title, $wgContLang, array(), global, Revision\newFromId(), Revision\newFromTitle(), IDBAccessObject\READ_NORMAL, LinkCache\singleton(), wfMessage(), and wfRunHooks().

Parser::stripAltText	(	$	caption,
		$	holders
	)		`[protected]`

Parameters:

$caption
$holders	LinkHolderArray

Returns:: mixed|String

Definition at line 5487 of file Parser.php.

Parser::stripSectionName ( $ text )

Strips a text string of wikitext for use in a section anchor.

Accepts a text string and then removes all wikitext from the string and leaves only the resultant text (i.e. the result of [[User:WikiSysop|Sysop]] would be "Sysop" and the result of [[User:WikiSysop]] would be "User:WikiSysop") - this is intended to create valid section anchors by mimicing the output of the parser when headings are parsed.

Parameters:

string $text text string to be stripped of wikitext for use in a Section anchor

Returns:: string Filtered text string

Definition at line 5916 of file Parser.php.

Parser::testPreprocess	(	$	text,
		Title $	title,
		ParserOptions $	options
	)

Parameters:

$text
$title	Title
$options	ParserOptions

Returns:: string

Definition at line 5970 of file Parser.php.

References $options, and ParserOptions\getUser().

Parser::testPst	(	$	text,
		Title $	title,
		ParserOptions $	options
	)

Parameters:

$text	string
$title	Title
$options	ParserOptions

Returns:: string

Definition at line 5960 of file Parser.php.

Parser::testSrvus	(	$	text,
		Title $	title,
		ParserOptions $	options,
		$	outputType = `self::OT_HTML`
	)

strip/replaceVariables/unstrip for preprocessor regression testing

Parameters:

$text	string
$title	Title
$options	ParserOptions
$outputType	int

Returns:: string

Definition at line 5945 of file Parser.php.

Parser::Title ( $ x = null )

Accessor/mutator for the Title object.

Parameters:

$x	Title object or null to just get the current one

Returns:: Title object

Definition at line 727 of file Parser.php.

Parser::transformMsg	(	$	text,
		$	options,
		$	title = `null`
	)

Wrapper for preprocess()

Parameters:

string	$text	the text to preprocess
	$options	ParserOptions: options
	$title	Title object or null to use $wgTitle

Returns:: String

Definition at line 4825 of file Parser.php.

Parser::uniqPrefix ( )

Accessor for mUniqPrefix.

Returns:: String

Definition at line 680 of file Parser.php.

Parser::unserializeHalfParsedText ( $ data )

Load the parser state given in the $data array, which is assumed to have been generated by serializeHalfParsedText().

The text contents is extracted from the array, and its markers are transformed into markers appropriate for the current Parser instance. This transformed text is returned, and can be safely included in the return value of a parser hook.

If the $data array has been stored persistently, the caller should first check whether it is still valid, by calling isValidHalfParsedText().

Parameters:

array $data Serialized data

Exceptions:

MWException

Returns:: String

Definition at line 6067 of file Parser.php.

Parser::validateSig ( $ text )

Check that the user's signature contains no bad XML.

Parameters:

$text String

Returns:: mixed An expanded string, or false if invalid.

Definition at line 4734 of file Parser.php.

Member Data Documentation

Parser::$mArgStack

Definition at line 157 of file Parser.php.

Parser::$mAutonumber

Definition at line 151 of file Parser.php.

Parser::$mConf

Definition at line 145 of file Parser.php.

Parser::$mDefaultSort

Definition at line 164 of file Parser.php.

Parser::$mDefaultStripList = array()

Definition at line 129 of file Parser.php.

Parser::$mDoubleUnderscores

Definition at line 166 of file Parser.php.

Parser::$mDTopen

Definition at line 151 of file Parser.php.

Parser::$mExpensiveFunctionCount

Definition at line 167 of file Parser.php.

Parser::$mExtLinkBracketedRegex

Definition at line 145 of file Parser.php.

Parser::$mFirstCall = true

Definition at line 134 of file Parser.php.

Parser::$mForceTocPosition

Definition at line 168 of file Parser.php.

Parser::$mFunctionHooks = array()

Definition at line 125 of file Parser.php.

Parser::$mFunctionSynonyms = array( 0 => array(), 1 => array() )

Definition at line 126 of file Parser.php.

Parser::$mFunctionTagHooks = array()

Definition at line 127 of file Parser.php.

Parser::$mGeneratedPPNodeCount

Definition at line 163 of file Parser.php.

Parser::$mHeadings

Definition at line 166 of file Parser.php.

Parser::$mHighestExpansionDepth

Definition at line 163 of file Parser.php.

Parser::$mImageParams = array()

Definition at line 131 of file Parser.php.

Parser::$mImageParamsMagicArray = array()

Definition at line 132 of file Parser.php.

Parser::$mIncludeCount

Definition at line 157 of file Parser.php.

Parser::$mIncludeSizes

Definition at line 163 of file Parser.php.

Parser::$mInPre

Definition at line 157 of file Parser.php.

Parser::$mInputSize = false

Definition at line 192 of file Parser.php.

Array Parser::$mLangLinkLanguages

with the language name of each language link (i.e.

the interwiki prefix) in the key, value arbitrary. Used to avoid sending duplicate language links to the ParserOutput.

Definition at line 202 of file Parser.php.

Parser::$mLastSection

Definition at line 157 of file Parser.php.

LinkHolderArray Parser::$mLinkHolders

Definition at line 160 of file Parser.php.

Parser::$mLinkID

Definition at line 162 of file Parser.php.

Parser::$mMarkerIndex = 0

Definition at line 133 of file Parser.php.

ParserOptions Parser::$mOptions

Definition at line 179 of file Parser.php.

ParserOutput Parser::$mOutput

Definition at line 150 of file Parser.php.

Parser::$mOutputType

Definition at line 184 of file Parser.php.

Parser::$mPPNodeCount

Definition at line 163 of file Parser.php.

Parser::$mPreprocessor

Definition at line 145 of file Parser.php.

Parser::$mRevIdForTs

Definition at line 191 of file Parser.php.

Parser::$mRevisionId

Definition at line 187 of file Parser.php.

Parser::$mRevisionObject

Definition at line 186 of file Parser.php.

Parser::$mRevisionSize

Definition at line 190 of file Parser.php.

Parser::$mRevisionTimestamp

Definition at line 188 of file Parser.php.

Parser::$mRevisionUser

Definition at line 189 of file Parser.php.

Parser::$mShowToc

Definition at line 168 of file Parser.php.

Parser::$mStripList = array()

Definition at line 128 of file Parser.php.

StripState Parser::$mStripState

Definition at line 155 of file Parser.php.

MagicWordArray Parser::$mSubstWords

Definition at line 144 of file Parser.php.

Parser::$mTagHooks = array()

Definition at line 123 of file Parser.php.

Title Parser::$mTitle

Definition at line 183 of file Parser.php.

Parser::$mTplDomCache

Definition at line 166 of file Parser.php.

Parser::$mTplExpandCache

Definition at line 165 of file Parser.php.

Parser::$mTplRedirCache

Definition at line 166 of file Parser.php.

Parser::$mTransparentTagHooks = array()

Definition at line 124 of file Parser.php.

string Parser::$mUniqPrefix

Definition at line 196 of file Parser.php.

Parser::$mUrlProtocols

Definition at line 145 of file Parser.php.

User Parser::$mUser

Definition at line 172 of file Parser.php.

Parser::$mVarCache = array()

Definition at line 130 of file Parser.php.

MagicWordArray Parser::$mVariables

Definition at line 140 of file Parser.php.

Parser::$ot

Definition at line 185 of file Parser.php.

const Parser::COLON_STATE_CLOSETAG = 3

Definition at line 98 of file Parser.php.

const Parser::COLON_STATE_COMMENT = 5

Definition at line 100 of file Parser.php.

const Parser::COLON_STATE_COMMENTDASH = 6

Definition at line 101 of file Parser.php.

const Parser::COLON_STATE_COMMENTDASHDASH = 7

Definition at line 102 of file Parser.php.

const Parser::COLON_STATE_TAG = 1

Definition at line 96 of file Parser.php.

const Parser::COLON_STATE_TAGSLASH = 4

Definition at line 99 of file Parser.php.

const Parser::COLON_STATE_TAGSTART = 2

Definition at line 97 of file Parser.php.

const Parser::COLON_STATE_TEXT = 0

Definition at line 95 of file Parser.php.

const Parser::EXT_IMAGE_REGEX

Initial value:

 '/^(http:\/\/|https:\/\/)([^][<>"\\x00-\\x20\\x7F\p{Zs}]+)
        \\/([A-Za-z0-9_.,~%\\-+&;#*?!=()@\\x80-\\xFF]+)\\.((?i)gif|png|jpg|jpeg)$/Sxu'

Definition at line 91 of file Parser.php.

const Parser::EXT_LINK_URL_CLASS = '[^][<>"\\x00-\\x20\\x7F\p{Zs}]'

Definition at line 90 of file Parser.php.

const Parser::HALF_PARSED_VERSION = 2

Update this version number when the output of serialiseHalfParsedText() changes in an incompatible way.

Definition at line 79 of file Parser.php.

const Parser::MARKER_SUFFIX = "-QINU\x7f"

Definition at line 116 of file Parser.php.

Referenced by StripState\__construct(), CoreParserFunctions\displaytitle(), StripState\getSubState(), insertStripItem(), and StripState\mergeCallback().

const Parser::OT_HTML = 1

Definition at line 109 of file Parser.php.

Referenced by ParserMethodsTest\testCallParserFunction().

const Parser::OT_MSG = 3

Definition at line 112 of file Parser.php.

const Parser::OT_PLAIN = 4

Definition at line 113 of file Parser.php.

const Parser::OT_PREPROCESS = 3

Definition at line 111 of file Parser.php.

const Parser::OT_WIKI = 2

Definition at line 110 of file Parser.php.

const Parser::PTD_FOR_INCLUSION = 1

Definition at line 105 of file Parser.php.

const Parser::SFH_NO_HASH = 1

Definition at line 83 of file Parser.php.

const Parser::SFH_OBJECT_ARGS = 2

Definition at line 84 of file Parser.php.

const Parser::TOC_END = '</mw:toc>'

Definition at line 120 of file Parser.php.

Referenced by ParserOutput\getText().

const Parser::TOC_START = '<mw:toc>'

Definition at line 119 of file Parser.php.

Referenced by ParserOutput\getText().

const Parser::VERSION = '1.6.4'

Update this version number when the ParserOutput format changes in an incompatible way, so the parser cache can automatically discard old data.

Definition at line 73 of file Parser.php.

Referenced by CacheTime\expired().

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

includes/parser/Parser.php
docs/linkcache.txt

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation