Inheritance diagram for ParserOutput:

Collaboration diagram for ParserOutput:

Public Member Functions
	__construct ( $text='', $languageLinks=[], $categoryLinks=[], $unused=false, $titletext='')

	__sleep ()

	addCategory ( $c, $sort)

	addExternalLink ( $url)

	addHeadItem ( $section, $tag=false)
	Add some text to the "<head>". More...

	addImage ( $name, $timestamp=null, $sha1=null)
	Register a file dependency for this output. More...

	addInterwikiLink ( $title)

	addJsConfigVars ( $keys, $value=null)
	Add one or more variables to be set in mw.config in JavaScript. More...

	addLanguageLink ( $t)

	addLink (Title $title, $id=null)
	Record a local or interwiki inline link for saving in future link tables. More...

	addModules ( $modules)

	addModuleScripts ( $modules)

	addModuleStyles ( $modules)

	addOutputHook ( $hook, $data=false)

	addOutputPageMetadata (OutputPage $out)
	Copy items from the OutputPage object into this one. More...

	addTemplate ( $title, $page_id, $rev_id)
	Register a template dependency for this output. More...

	addTrackingCategory ( $msg, $title)
	Add a tracking category, getting the title from a system message, or print a debug message if the title is invalid. More...

	addWarning ( $s)

	finalizeAdaptiveCacheExpiry ()
	Call this when parsing is done to lower the TTL based on low parse times. More...

&	getCategories ()

	getCategoryLinks ()

	getDisplayTitle ()
	Get the title to be used for display. More...

	getEditSectionTokens ()

	getEnableOOUI ()

	getExtensionData ( $key)
	Gets extensions data previously attached to this ParserOutput using setExtensionData(). More...

&	getExternalLinks ()

&	getFileSearchOptions ()

	getFlag ( $flag)

	getHeadItems ()

	getHideNewSection ()

&	getImages ()

	getIndexPolicy ()

	getIndicators ()

	getInterwikiLinks ()

	getJsConfigVars ()

&	getLanguageLinks ()

	getLimitReportData ()

	getLimitReportJSData ()

&	getLinks ()

	getModules ()

	getModuleScripts ()

	getModuleStyles ()

	getNewSection ()

	getNoGallery ()

	getOutputHooks ()

	getProperties ()

	getProperty ( $name)

	getRawText ()
	Get the cacheable text with <mw:editsection> markers still in it. More...

	getSections ()

	getSpeculativeRevIdUsed ()

&	getTemplateIds ()

&	getTemplates ()

	getText ()

	getTimeSinceStart ( $clock)
	Returns the time since resetParseStartTime() was last called. More...

	getTimestamp ()

	getTitleText ()

	getTOCEnabled ()

	getTOCHTML ()

	getUsedOptions ()
	Returns the options from its ParserOptions which have been taken into account to produce this output or false if not available. More...

	getWarnings ()

	hasDynamicContent ()
	Check whether the cache TTL was lowered due to dynamic content. More...

	hideNewSection ( $value)

	preventClickjacking ( $flag=null)
	Get or set the prevent-clickjacking flag. More...

	recordOption ( $option)
	Tags a parser option for use in the cache key for this parser output. More...

	resetParseStartTime ()
	Resets the parse start timestamps for future calls to getTimeSinceStart() More...

	setCategoryLinks ( $cl)

	setDisplayTitle ( $text)
	Override the title to be used for display. More...

	setEditSectionTokens ( $t)

	setEnableOOUI ( $enable=false)
	Enables OOUI, if true, in any OutputPage instance this ParserOutput object is added to. More...

	setExtensionData ( $key, $value)
	Attaches arbitrary data to this ParserObject. More...

	setFlag ( $flag)
	Fairly generic flag setter thingy. More...

	setIndexPolicy ( $policy)

	setIndicator ( $id, $content)

	setLanguageLinks ( $ll)

	setLimitReportData ( $key, $value)
	Sets parser limit report data for a key. More...

	setNewSection ( $value)

	setProperty ( $name, $value)
	Set a property to be stored in the page_props database table. More...

	setSections ( $toc)

	setSpeculativeRevIdUsed ( $id)

	setText ( $text)

	setTimestamp ( $timestamp)

	setTitleText ( $t)

	setTOCEnabled ( $flag)

	setTOCHTML ( $tochtml)

	unsetProperty ( $name)

	updateRuntimeAdaptiveExpiry ( $ttl)
	Lower the runtime adaptive TTL to at most this value. More...

Public Member Functions inherited from CacheTime
	expired ( $touched)
	Return true if this cached output object predates the global or per-article cache invalidation timestamps, or if it comes from an incompatible older version. More...

	getCacheExpiry ()
	Returns the number of seconds after which this object should expire. More...

	getCacheRevisionId ()

	getCacheTime ()

	isCacheable ()

	isDifferentRevision ( $id)
	Return true if this cached output object is for a different revision of the page. More...

	setCacheRevisionId ( $id)

	setCacheTime ( $t)
	setCacheTime() sets the timestamp expressing when the page has been rendered. More...

	updateCacheExpiry ( $seconds)
	Sets the number of seconds after which this object should expire. More...

Static Public Member Functions
static	isLinkInternal ( $internal, $url)
	Checks, if a url is pointing to the own server. More...

Public Attributes
	$mCategories

	$mEditSectionTokens = false

	$mEnableOOUI = false

	$mExternalLinks = []

	$mFileSearchOptions = []

	$mHeadItems = []

	$mHideNewSection = false

	$mImages = []

	$mIndicators = []

	$mInterwikiLinks = []

	$mJsConfigVars = []

	$mLanguageLinks

	$mLinks = []

	$mModules = []

	$mModuleScripts = []

	$mModuleStyles = []

	$mNewSection = false

	$mNoGallery = false

	$mOutputHooks = []

	$mProperties = []

	$mSections = []

	$mTemplateIds = []

	$mTemplates = []

	$mText

	$mTimestamp

	$mTitleText

	$mTOCEnabled = true

	$mTOCHTML = ''

	$mWarnings = []

const	EDITSECTION_REGEX

const	FAST_AR_TTL = 60

const	MIN_AR_TTL = 15

const	PARSE_FAST_SEC = .100

const	PARSE_SLOW_SEC = 1.0

const	SLOW_AR_TTL = 3600

Public Attributes inherited from CacheTime
	$mCacheExpiry = null

	$mCacheRevisionId = null

	$mCacheTime = ''

array bool	$mUsedOptions
	ParserOptions which have been taken into account to produce output or false if not available. More...

	$mVersion = Parser::VERSION

Static Private Member Functions
static	getTimes ( $clock=null)

Private Attributes
	$mAccessedOptions = []

	$mExtensionData = []

	$mFlags = []

	$mIndexPolicy = ''

	$mLimitReportData = []

array	$mLimitReportJSData = []
	Parser limit report data for JSON. More...

integer	$mMaxAdaptiveExpiry = INF
	Upper bound of expiry based on parse duration. More...

	$mParseStartTime = []

	$mPreventClickjacking = false

integer null	$mSpeculativeRevId
	Assumed rev ID for {{REVISIONID}} if no revision is set. More...

Detailed Description

Definition at line 24 of file ParserOutput.php.

Constructor & Destructor Documentation

◆ __construct()

ParserOutput::__construct	(	$text = `''`,
		$languageLinks = `[]`,
		$categoryLinks = `[]`,
		$unused = `false`,
		$titletext = `''`
	)

Definition at line 232 of file ParserOutput.php.

Member Function Documentation

◆ __sleep()

ParserOutput::__sleep ( )

Definition at line 1111 of file ParserOutput.php.

◆ addCategory()

ParserOutput::addCategory	(	$c,
		$sort
	)

Definition at line 469 of file ParserOutput.php.

References $sort.

Referenced by addTrackingCategory().

◆ addExternalLink()

ParserOutput::addExternalLink ( $url )

Definition at line 534 of file ParserOutput.php.

References $wgServer, global, and isLinkInternal().

◆ addHeadItem()

ParserOutput::addHeadItem	(	$section,
		$tag = `false`
	)

Add some text to the "<head>".

If $tag is set, the section with that tag will only be included once in a given page.

Parameters

string	$section
string \| bool	$tag

Definition at line 641 of file ParserOutput.php.

References $section, and $tag.

◆ addImage()

ParserOutput::addImage	(	$name,
		$timestamp = `null`,
		$sha1 = `null`
	)

Register a file dependency for this output.

Parameters

string	$name	Title dbKey
string	$timestamp	MW timestamp of file creation (or false if non-existing)
string	$sha1	Base 36 SHA-1 of file (or false if non-existing)

Returns: void

Definition at line 592 of file ParserOutput.php.

References $name.

◆ addInterwikiLink()

ParserOutput::addInterwikiLink ( $title )

Parameters

Title $title Title object, must be an interwiki link

Exceptions

MWException If given invalid input

Definition at line 623 of file ParserOutput.php.

References $title.

Referenced by addLink().

◆ addJsConfigVars()

ParserOutput::addJsConfigVars	(	$keys,
		$value = `null`
	)

Add one or more variables to be set in mw.config in JavaScript.

Parameters

string \| array	$keys	Key or array of key/value pairs.
mixed	$value	[optional] Value of the configuration variable.

Since: 1.23

Definition at line 668 of file ParserOutput.php.

References $keys, $value, and as.

Referenced by addOutputPageMetadata().

◆ addLanguageLink()

ParserOutput::addLanguageLink ( $t )

Definition at line 491 of file ParserOutput.php.

References $t.

◆ addLink()

ParserOutput::addLink	(	Title	$title,
			$id = `null`
	)

Record a local or interwiki inline link for saving in future link tables.

Parameters

Title	$title
int \| null	$id	Optional known page_id so we can skip the lookup

Definition at line 557 of file ParserOutput.php.

References $title, addInterwikiLink(), NS_FILE, NS_MEDIA, and NS_SPECIAL.

◆ addModules()

ParserOutput::addModules ( $modules )

Definition at line 649 of file ParserOutput.php.

References $modules, and array().

Referenced by addOutputPageMetadata().

◆ addModuleScripts()

ParserOutput::addModuleScripts ( $modules )

Definition at line 653 of file ParserOutput.php.

References $modules, and array().

Referenced by addOutputPageMetadata().

◆ addModuleStyles()

ParserOutput::addModuleStyles ( $modules )

Definition at line 657 of file ParserOutput.php.

References $modules, and array().

Referenced by addOutputPageMetadata().

◆ addOutputHook()

ParserOutput::addOutputHook	(	$hook,
		$data = `false`
	)

Definition at line 499 of file ParserOutput.php.

◆ addOutputPageMetadata()

ParserOutput::addOutputPageMetadata ( OutputPage $out )

Copy items from the OutputPage object into this one.

Parameters

OutputPage $out

Definition at line 684 of file ParserOutput.php.

References $out, addJsConfigVars(), addModules(), addModuleScripts(), addModuleStyles(), OutputPage\getJsConfigVars(), OutputPage\getModules(), OutputPage\getModuleScripts(), and OutputPage\getModuleStyles().

◆ addTemplate()

ParserOutput::addTemplate	(	$title,
		$page_id,
		$rev_id
	)

Register a template dependency for this output.

Parameters

Title	$title
int	$page_id
int	$rev_id

Returns: void

Definition at line 606 of file ParserOutput.php.

References $title.

◆ addTrackingCategory()

ParserOutput::addTrackingCategory	(	$msg,
		$title
	)

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

Any message used with this function should be registered so it will show up on Special:TrackingCategories. Core messages should be added to SpecialTrackingCategories::$coreTrackingCategories, and extensions should add to "TrackingCategories" in their extension.json.

Todo:: Migrate some code to TrackingCategories

Parameters

string	$msg	Message key
Title	$title	title of the page which is being tracked

Returns: bool Whether the addition was successful

Since: 1.25

Definition at line 710 of file ParserOutput.php.

References $title, addCategory(), getProperty(), Title\makeTitleSafe(), NS_CATEGORY, NS_SPECIAL, wfDebug(), and wfMessage().

◆ addWarning()

ParserOutput::addWarning ( $s )

Definition at line 495 of file ParserOutput.php.

References $s.

◆ finalizeAdaptiveCacheExpiry()

ParserOutput::finalizeAdaptiveCacheExpiry ( )

Call this when parsing is done to lower the TTL based on low parse times.

Since: 1.28

Definition at line 1091 of file ParserOutput.php.

References FAST_AR_TTL, getTimeSinceStart(), and CacheTime\updateCacheExpiry().

◆ getCategories()

& ParserOutput::getCategories ( )

Definition at line 318 of file ParserOutput.php.

References $mCategories.

Referenced by SpecialExpandTemplates\showHtmlPreview().

◆ getCategoryLinks()

ParserOutput::getCategoryLinks ( )

Definition at line 314 of file ParserOutput.php.

◆ getDisplayTitle()

ParserOutput::getDisplayTitle ( )

Get the title to be used for display.

As per the contract of setDisplayTitle(), this is safe HTML, ready to be served to the client.

Returns: string HTML

Definition at line 761 of file ParserOutput.php.

References $t, and getTitleText().

◆ getEditSectionTokens()

ParserOutput::getEditSectionTokens ( )

Definition at line 337 of file ParserOutput.php.

References $mEditSectionTokens.

◆ getEnableOOUI()

ParserOutput::getEnableOOUI ( )

Definition at line 425 of file ParserOutput.php.

References $mEnableOOUI.

◆ getExtensionData()

ParserOutput::getExtensionData ( $key )

Gets extensions data previously attached to this ParserOutput using setExtensionData().

Typically, such data would be set while parsing the page, e.g. by a parser function.

Since: 1.21

Parameters

string $key The key to look up.

Returns: mixed|null The value previously set for the given key using setExtensionData() or null if no value was set for this key.

Definition at line 954 of file ParserOutput.php.

◆ getExternalLinks()

& ParserOutput::getExternalLinks ( )

Definition at line 361 of file ParserOutput.php.

References $mExternalLinks.

◆ getFileSearchOptions()

& ParserOutput::getFileSearchOptions ( )

Definition at line 357 of file ParserOutput.php.

References $mFileSearchOptions.

◆ getFlag()

ParserOutput::getFlag ( $flag )

Definition at line 777 of file ParserOutput.php.

◆ getHeadItems()

ParserOutput::getHeadItems ( )

Definition at line 369 of file ParserOutput.php.

References $mHeadItems.

◆ getHideNewSection()

ParserOutput::getHideNewSection ( )

Definition at line 509 of file ParserOutput.php.

References $mHideNewSection.

◆ getImages()

& ParserOutput::getImages ( )

Definition at line 353 of file ParserOutput.php.

References $mImages.

◆ getIndexPolicy()

ParserOutput::getIndexPolicy ( )

Definition at line 398 of file ParserOutput.php.

References $mIndexPolicy.

◆ getIndicators()

ParserOutput::getIndicators ( )

Since: 1.25

Definition at line 325 of file ParserOutput.php.

References $mIndicators.

◆ getInterwikiLinks()

ParserOutput::getInterwikiLinks ( )

Definition at line 310 of file ParserOutput.php.

References $mInterwikiLinks.

◆ getJsConfigVars()

ParserOutput::getJsConfigVars ( )

Since: 1.23

Definition at line 386 of file ParserOutput.php.

References $mJsConfigVars.

◆ getLanguageLinks()

& ParserOutput::getLanguageLinks ( )

Definition at line 306 of file ParserOutput.php.

References $mLanguageLinks.

◆ getLimitReportData()

ParserOutput::getLimitReportData ( )

Definition at line 413 of file ParserOutput.php.

References $mLimitReportData.

◆ getLimitReportJSData()

ParserOutput::getLimitReportJSData ( )

Definition at line 417 of file ParserOutput.php.

References $mLimitReportJSData.

◆ getLinks()

& ParserOutput::getLinks ( )

Definition at line 341 of file ParserOutput.php.

References $mLinks.

◆ getModules()

ParserOutput::getModules ( )

Definition at line 373 of file ParserOutput.php.

References $mModules.

◆ getModuleScripts()

ParserOutput::getModuleScripts ( )

Definition at line 377 of file ParserOutput.php.

References $mModuleScripts.

◆ getModuleStyles()

ParserOutput::getModuleStyles ( )

Definition at line 381 of file ParserOutput.php.

References $mModuleStyles.

◆ getNewSection()

ParserOutput::getNewSection ( )

Definition at line 512 of file ParserOutput.php.

References $mNewSection.

◆ getNoGallery()

ParserOutput::getNoGallery ( )

Definition at line 365 of file ParserOutput.php.

References $mNoGallery.

◆ getOutputHooks()

ParserOutput::getOutputHooks ( )

Definition at line 390 of file ParserOutput.php.

References $mOutputHooks, and array().

◆ getProperties()

ParserOutput::getProperties ( )

Definition at line 860 of file ParserOutput.php.

References $mProperties.

◆ getProperty()

ParserOutput::getProperty ( $name )

Parameters

string $name The property name to look up.

Returns: mixed|bool The value previously set using setProperty(). False if null or no value was set for the given property name.

Note: You need to use getProperties() to check for boolean and null properties.

Definition at line 852 of file ParserOutput.php.

References $name.

Referenced by addTrackingCategory().

◆ getRawText()

ParserOutput::getRawText ( )

Get the cacheable text with <mw:editsection> markers still in it.

The return value is suitable for writing back via setText() but is not valid for display to the user.

Since: 1.27

Definition at line 248 of file ParserOutput.php.

References $mText.

◆ getSections()

ParserOutput::getSections ( )

Definition at line 333 of file ParserOutput.php.

References $mSections.

◆ getSpeculativeRevIdUsed()

ParserOutput::getSpeculativeRevIdUsed ( )

Since: 1.28

Definition at line 302 of file ParserOutput.php.

References $mSpeculativeRevId.

◆ getTemplateIds()

& ParserOutput::getTemplateIds ( )

Definition at line 349 of file ParserOutput.php.

References $mTemplateIds.

◆ getTemplates()

& ParserOutput::getTemplates ( )

Definition at line 345 of file ParserOutput.php.

References $mTemplates.

◆ getText()

ParserOutput::getText ( )

Definition at line 252 of file ParserOutput.php.

References $mText, $skin, $wgLang, $wgOut, EDITSECTION_REGEX, global, and Title\newFromText().

◆ getTimes()

static ParserOutput::getTimes ( $clock = null )

staticprivate

Definition at line 962 of file ParserOutput.php.

References $ret, and wfGetRusage().

Referenced by getTimeSinceStart(), and resetParseStartTime().

◆ getTimeSinceStart()

array $mParseStartTime Timestamps for ParserOutput::getTimeSinceStart ( $clock )

Returns the time since resetParseStartTime() was last called.

Clocks available are:

wall: Wall clock time
cpu: CPU time (requires getrusage)

Since: 1.22

Parameters

string $clock

Returns: float|null

Definition at line 996 of file ParserOutput.php.

References getTimes().

Referenced by finalizeAdaptiveCacheExpiry().

◆ getTimestamp()

ParserOutput::getTimestamp ( )

Returns: string|null TS_MW timestamp of the revision content

Definition at line 409 of file ParserOutput.php.

References $mTimestamp.

◆ getTitleText()

ParserOutput::getTitleText ( )

Definition at line 329 of file ParserOutput.php.

References $mTitleText.

Referenced by Article\adjustDisplayTitle(), and getDisplayTitle().

◆ getTOCEnabled()

ParserOutput::getTOCEnabled ( )

Definition at line 421 of file ParserOutput.php.

References $mTOCEnabled.

◆ getTOCHTML()

ParserOutput::getTOCHTML ( )

Definition at line 402 of file ParserOutput.php.

References $mTOCHTML.

◆ getUsedOptions()

ParserOutput::getUsedOptions ( )

Returns the options from its ParserOptions which have been taken into account to produce this output or false if not available.

Returns: array

Definition at line 872 of file ParserOutput.php.

◆ getWarnings()

ParserOutput::getWarnings ( )

Definition at line 394 of file ParserOutput.php.

◆ hasDynamicContent()

ParserOutput::hasDynamicContent ( )

Check whether the cache TTL was lowered due to dynamic content.

When content is determined by more than hard state (e.g. page edits), such as template/file transclusions based on the current timestamp or extension tags that generate lists based on queries, this return true.

Returns: bool

Since: 1.25

Definition at line 1058 of file ParserOutput.php.

References $wgParserCacheExpireTime, CacheTime\getCacheExpiry(), and global.

◆ hideNewSection()

ParserOutput::hideNewSection ( $value )

Definition at line 506 of file ParserOutput.php.

References $value.

◆ isLinkInternal()

static ParserOutput::isLinkInternal	(	$internal,
		$url
	)

static

Checks, if a url is pointing to the own server.

Parameters

string	$internal	The server to check against
string	$url	The url to check

Returns: bool

Definition at line 523 of file ParserOutput.php.

References check, http, https, If, in, is(), link, links, of, or, query, and server.

Referenced by addExternalLink(), and ParserOutputTest\testIsLinkInternal().

◆ preventClickjacking()

ParserOutput::preventClickjacking ( $flag = null )

Get or set the prevent-clickjacking flag.

Since: 1.24

Parameters

bool | null $flag New flag value, or null to leave it unchanged

Returns: bool Old flag value

Definition at line 1071 of file ParserOutput.php.

References wfSetVar().

◆ recordOption()

ParserOutput::recordOption ( $option )

Tags a parser option for use in the cache key for this parser output.

Registered as a watcher at ParserOptions::registerWatcher() by Parser::clearState(). The information gathered here is available via getUsedOptions(), and is used by ParserCache::save().

See also: ParserCache::getKey; ParserCache::save; ParserOptions::addExtraKey; ParserOptions::optionsHash

Parameters

string $option

Definition at line 891 of file ParserOutput.php.

◆ resetParseStartTime()

ParserOutput::resetParseStartTime ( )

Resets the parse start timestamps for future calls to getTimeSinceStart()

Since: 1.22

Definition at line 981 of file ParserOutput.php.

References getTimes().

◆ setCategoryLinks()

ParserOutput::setCategoryLinks ( $cl )

Definition at line 437 of file ParserOutput.php.

References wfSetVar().

◆ setDisplayTitle()

ParserOutput::setDisplayTitle ( $text )

Override the title to be used for display.

Note: this is assumed to have been validated (check equal normalisation, etc.); this is expected to be safe HTML, ready to be served to the client.

Parameters

string $text Desired title text

Definition at line 748 of file ParserOutput.php.

References setProperty(), and setTitleText().

◆ setEditSectionTokens()

ParserOutput::setEditSectionTokens ( $t )

Definition at line 449 of file ParserOutput.php.

References $t, and wfSetVar().

◆ setEnableOOUI()

ParserOutput::setEnableOOUI ( $enable = false )

Enables OOUI, if true, in any OutputPage instance this ParserOutput object is added to.

Since: 1.26

Parameters

bool $enable If OOUI should be enabled or not

Definition at line 487 of file ParserOutput.php.

◆ setExtensionData()

ParserOutput::setExtensionData	(	$key,
		$value
	)

Attaches arbitrary data to this ParserObject.

This can be used to store some information in the ParserOutput object for later use during page output. The data will be cached along with the ParserOutput object, but unlike data set using setProperty(), it is not recorded in the database.

This method is provided to overcome the unsafe practice of attaching extra information to a ParserObject by directly assigning member variables.

To use setExtensionData() to pass extension information from a hook inside the parser to a hook in the page output, use this in the parser hook:

Example:: $parser->getOutput()->setExtensionData( 'my_ext_foo', '...' );

And then later, in OutputPageParserOutput or similar:

Example:: $output->getExtensionData( 'my_ext_foo' );

In MediaWiki 1.20 and older, you have to use a custom member variable within the ParserOutput object:

Example:: $parser->getOutput()->my_ext_foo = '...';

Since: 1.21

Parameters

string	$key	The key for accessing the data. Extensions should take care to avoid conflicts in naming keys. It is suggested to use the extension's name as a prefix.
mixed	$value	The value to set. Setting a value to null is equivalent to removing the value.

Definition at line 935 of file ParserOutput.php.

References $value.

◆ setFlag()

ParserOutput::setFlag ( $flag )

Fairly generic flag setter thingy.

Parameters

string $flag

Definition at line 773 of file ParserOutput.php.

◆ setIndexPolicy()

ParserOutput::setIndexPolicy ( $policy )

Definition at line 453 of file ParserOutput.php.

References wfSetVar().

◆ setIndicator()

ParserOutput::setIndicator	(	$id,
		$content
	)

Since: 1.25

Definition at line 476 of file ParserOutput.php.

References $content.

◆ setLanguageLinks()

ParserOutput::setLanguageLinks ( $ll )

Definition at line 433 of file ParserOutput.php.

References wfSetVar().

◆ setLimitReportData()

ParserOutput::setLimitReportData	(	$key,
		$value
	)

Sets parser limit report data for a key.

The key is used as the prefix for various messages used for formatting:

$key: The label for the field in the limit report
$key-value-text: Message used to format the value in the "NewPP limit report" HTML comment. If missing, uses $key-format.
$key-value-html: Message used to format the value in the preview limit report table. If missing, uses $key-format.
$key-value: Message used to format the value. If missing, uses "$1".

Note that all values are interpreted as wikitext, and so should be encoded with htmlspecialchars() as necessary, but should avoid complex HTML for sanity of display in the "NewPP limit report" comment.

Since: 1.22

Parameters

string	$key	Message key
mixed	$value	Appropriate for Message::params()

Definition at line 1024 of file ParserOutput.php.

References $name, $value, and list.

◆ setNewSection()

ParserOutput::setNewSection ( $value )

Definition at line 503 of file ParserOutput.php.

References $value.

◆ setProperty()

ParserOutput::setProperty	(	$name,
		$value
	)

Set a property to be stored in the page_props database table.

page_props is a key value store indexed by the page ID. This allows the parser to set a property on a page which can then be quickly retrieved given the page ID or via a DB join when given the page title.

Since 1.23, page_props are also indexed by numeric value, to allow for efficient "top k" queries of pages wrt a given property.

setProperty() is thus used to propagate properties from the parsed page to request contexts other than a page view of the currently parsed article.

Some applications examples:

To implement hidden categories, hiding pages from category listings by storing a property.
Overriding the displayed article title.
See also
ParserOutput::setDisplayTitle()
To implement image tagging, for example displaying an icon on an image thumbnail to indicate that it is listed for deletion on Wikimedia Commons. This is not actually implemented, yet but would be pretty cool.

Note: Do not use setProperty() to set a property which is only used in a context where the ParserOutput object itself is already available, for example a normal page view. There is no need to save such a property in the database since the text is already parsed. You can just hook OutputPageParserOutput and get your data out of the ParserOutput object.

If you are writing an extension where you want to set a property in the parser which is used by an OutputPageParserOutput hook, you have to associate the extension data directly with the ParserOutput object. Since MediaWiki 1.21, you can use setExtensionData() to do this:

Example:: $parser->getOutput()->setExtensionData( 'my_ext_foo', '...' );

And then later, in OutputPageParserOutput or similar:

Example:: $output->getExtensionData( 'my_ext_foo' );

In MediaWiki 1.20 and older, you have to use a custom member variable within the ParserOutput object:

Example:: $parser->getOutput()->my_ext_foo = '...';

Definition at line 840 of file ParserOutput.php.

References $name, and $value.

Referenced by setDisplayTitle().

◆ setSections()

ParserOutput::setSections ( $toc )

Definition at line 445 of file ParserOutput.php.

References wfSetVar().

◆ setSpeculativeRevIdUsed()

ParserOutput::setSpeculativeRevIdUsed ( $id )

Parameters

integer $id

Since: 1.28

Definition at line 297 of file ParserOutput.php.

◆ setText()

ParserOutput::setText ( $text )

Definition at line 429 of file ParserOutput.php.

References wfSetVar().

Referenced by JsonContent\fillParserOutput(), TextContent\fillParserOutput(), WikitextContent\fillParserOutput(), TablePager\getBodyOutput(), and TablePager\getFullOutput().

◆ setTimestamp()

ParserOutput::setTimestamp ( $timestamp )

Definition at line 461 of file ParserOutput.php.

References wfSetVar().

◆ setTitleText()

ParserOutput::setTitleText ( $t )

Definition at line 441 of file ParserOutput.php.

References $t, and wfSetVar().

Referenced by setDisplayTitle().

◆ setTOCEnabled()

ParserOutput::setTOCEnabled ( $flag )

Definition at line 465 of file ParserOutput.php.

References wfSetVar().

◆ setTOCHTML()

ParserOutput::setTOCHTML ( $tochtml )

Definition at line 457 of file ParserOutput.php.

References wfSetVar().

◆ unsetProperty()

ParserOutput::unsetProperty ( $name )

Definition at line 856 of file ParserOutput.php.

References $name.

◆ updateRuntimeAdaptiveExpiry()

ParserOutput::updateRuntimeAdaptiveExpiry ( $ttl )

Lower the runtime adaptive TTL to at most this value.

Parameters

integer $ttl

Since: 1.28

Definition at line 1081 of file ParserOutput.php.

References CacheTime\updateCacheExpiry().

Member Data Documentation

◆ $mAccessedOptions

ParserOutput::$mAccessedOptions = []

private

Definition at line 184 of file ParserOutput.php.

◆ $mCategories

ParserOutput::$mCategories

Definition at line 39 of file ParserOutput.php.

Referenced by getCategories().

◆ $mEditSectionTokens

ParserOutput::$mEditSectionTokens = false

Definition at line 149 of file ParserOutput.php.

Referenced by getEditSectionTokens().

◆ $mEnableOOUI

ParserOutput::$mEnableOOUI = false

Definition at line 174 of file ParserOutput.php.

Referenced by getEnableOOUI().

◆ $mExtensionData

ParserOutput::$mExtensionData = []

private

Definition at line 189 of file ParserOutput.php.

◆ $mExternalLinks

ParserOutput::$mExternalLinks = []

Definition at line 82 of file ParserOutput.php.

Referenced by getExternalLinks().

◆ $mFileSearchOptions

ParserOutput::$mFileSearchOptions = []

Definition at line 77 of file ParserOutput.php.

Referenced by getFileSearchOptions().

◆ $mFlags

ParserOutput::$mFlags = []

private

Definition at line 212 of file ParserOutput.php.

◆ $mHeadItems

ParserOutput::$mHeadItems = []

Definition at line 108 of file ParserOutput.php.

Referenced by getHeadItems().

◆ $mHideNewSection

ParserOutput::$mHideNewSection = false

Definition at line 98 of file ParserOutput.php.

Referenced by getHideNewSection().

◆ $mImages

ParserOutput::$mImages = []

Definition at line 72 of file ParserOutput.php.

Referenced by getImages().

◆ $mIndexPolicy

ParserOutput::$mIndexPolicy = ''

private

Definition at line 179 of file ParserOutput.php.

Referenced by getIndexPolicy().

◆ $mIndicators

ParserOutput::$mIndicators = []

Definition at line 44 of file ParserOutput.php.

Referenced by getIndicators().

◆ $mInterwikiLinks

ParserOutput::$mInterwikiLinks = []

Definition at line 88 of file ParserOutput.php.

Referenced by getInterwikiLinks().

◆ $mJsConfigVars

ParserOutput::$mJsConfigVars = []

Definition at line 128 of file ParserOutput.php.

Referenced by getJsConfigVars().

◆ $mLanguageLinks

ParserOutput::$mLanguageLinks

Definition at line 34 of file ParserOutput.php.

Referenced by getLanguageLinks().

◆ $mLimitReportData

ParserOutput::$mLimitReportData = []

private

Definition at line 194 of file ParserOutput.php.

Referenced by getLimitReportData().

◆ $mLimitReportJSData

array ParserOutput::$mLimitReportJSData = []

private

Parser limit report data for JSON.

Definition at line 197 of file ParserOutput.php.

Referenced by getLimitReportJSData().

◆ $mLinks

ParserOutput::$mLinks = []

Definition at line 55 of file ParserOutput.php.

Referenced by getLinks().

◆ $mMaxAdaptiveExpiry

integer ParserOutput::$mMaxAdaptiveExpiry = INF

private

Upper bound of expiry based on parse duration.

Definition at line 218 of file ParserOutput.php.

◆ $mModules

ParserOutput::$mModules = []

Definition at line 113 of file ParserOutput.php.

Referenced by getModules().

◆ $mModuleScripts

ParserOutput::$mModuleScripts = []

Definition at line 118 of file ParserOutput.php.

Referenced by getModuleScripts().

◆ $mModuleStyles

ParserOutput::$mModuleStyles = []

Definition at line 123 of file ParserOutput.php.

Referenced by getModuleStyles().

◆ $mNewSection

ParserOutput::$mNewSection = false

Definition at line 93 of file ParserOutput.php.

Referenced by getNewSection().

◆ $mNoGallery

ParserOutput::$mNoGallery = false

Definition at line 103 of file ParserOutput.php.

Referenced by getNoGallery().

◆ $mOutputHooks

ParserOutput::$mOutputHooks = []

Definition at line 133 of file ParserOutput.php.

Referenced by getOutputHooks().

◆ $mParseStartTime

ParserOutput::$mParseStartTime = []

private

Definition at line 202 of file ParserOutput.php.

◆ $mPreventClickjacking

ParserOutput::$mPreventClickjacking = false

private

Definition at line 207 of file ParserOutput.php.

◆ $mProperties

ParserOutput::$mProperties = []

Definition at line 154 of file ParserOutput.php.

Referenced by getProperties().

◆ $mSections

ParserOutput::$mSections = []

Definition at line 144 of file ParserOutput.php.

Referenced by getSections().

◆ $mSpeculativeRevId

integer null ParserOutput::$mSpeculativeRevId

private

Assumed rev ID for {{REVISIONID}} if no revision is set.

Definition at line 215 of file ParserOutput.php.

Referenced by getSpeculativeRevIdUsed().

◆ $mTemplateIds

ParserOutput::$mTemplateIds = []

Definition at line 67 of file ParserOutput.php.

Referenced by getTemplateIds().

◆ $mTemplates

ParserOutput::$mTemplates = []

Definition at line 61 of file ParserOutput.php.

Referenced by getTemplates().

◆ $mText

ParserOutput::$mText

Definition at line 28 of file ParserOutput.php.

Referenced by getRawText(), and getText().

◆ $mTimestamp

ParserOutput::$mTimestamp

Definition at line 164 of file ParserOutput.php.

Referenced by getTimestamp().

◆ $mTitleText

ParserOutput::$mTitleText

Definition at line 49 of file ParserOutput.php.

Referenced by getTitleText().

◆ $mTOCEnabled

ParserOutput::$mTOCEnabled = true

Definition at line 169 of file ParserOutput.php.

Referenced by getTOCEnabled().

◆ $mTOCHTML

ParserOutput::$mTOCHTML = ''

Definition at line 159 of file ParserOutput.php.

Referenced by getTOCHTML().

◆ $mWarnings

ParserOutput::$mWarnings = []

Definition at line 139 of file ParserOutput.php.

◆ EDITSECTION_REGEX

const ParserOutput::EDITSECTION_REGEX

Initial value:

=

'#<(?:mw:)?editsection page="(.*?)" section="(.*?)"(?:/>|>(.*?)(</(?:mw:)?editsection>))#s'

Definition at line 220 of file ParserOutput.php.

Referenced by getText(), and MediaWiki\Tidy\RaggettWrapper\getWrapped().

◆ FAST_AR_TTL

const ParserOutput::FAST_AR_TTL = 60

Definition at line 228 of file ParserOutput.php.

Referenced by finalizeAdaptiveCacheExpiry().

◆ MIN_AR_TTL

const ParserOutput::MIN_AR_TTL = 15

Definition at line 230 of file ParserOutput.php.

◆ PARSE_FAST_SEC

const ParserOutput::PARSE_FAST_SEC = .100

Definition at line 226 of file ParserOutput.php.

◆ PARSE_SLOW_SEC

const ParserOutput::PARSE_SLOW_SEC = 1.0

Definition at line 227 of file ParserOutput.php.

◆ SLOW_AR_TTL

const ParserOutput::SLOW_AR_TTL = 3600

Definition at line 229 of file ParserOutput.php.

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

includes/parser/ParserOutput.php

Public Member Functions

Static Public Member Functions

Public Attributes

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __sleep()

◆ addCategory()

◆ addExternalLink()

◆ addHeadItem()

◆ addImage()

◆ addInterwikiLink()

◆ addJsConfigVars()

◆ addLanguageLink()

◆ addLink()

◆ addModules()

◆ addModuleScripts()

◆ addModuleStyles()

◆ addOutputHook()

◆ addOutputPageMetadata()

◆ addTemplate()

◆ addTrackingCategory()

◆ addWarning()

◆ finalizeAdaptiveCacheExpiry()

◆ getCategories()

◆ getCategoryLinks()

◆ getDisplayTitle()

◆ getEditSectionTokens()

◆ getEnableOOUI()

◆ getExtensionData()

◆ getExternalLinks()

◆ getFileSearchOptions()

◆ getFlag()

◆ getHeadItems()

◆ getHideNewSection()

◆ getImages()

◆ getIndexPolicy()

◆ getIndicators()

◆ getInterwikiLinks()

◆ getJsConfigVars()

◆ getLanguageLinks()

◆ getLimitReportData()

◆ getLimitReportJSData()

◆ getLinks()

◆ getModules()

◆ getModuleScripts()

◆ getModuleStyles()

◆ getNewSection()

◆ getNoGallery()

◆ getOutputHooks()

◆ getProperties()

◆ getProperty()

◆ getRawText()

◆ getSections()

◆ getSpeculativeRevIdUsed()

◆ getTemplateIds()

◆ getTemplates()

◆ getText()

◆ getTimes()

◆ getTimeSinceStart()

◆ getTimestamp()

◆ getTitleText()

◆ getTOCEnabled()

◆ getTOCHTML()

◆ getUsedOptions()

◆ getWarnings()

◆ hasDynamicContent()

◆ hideNewSection()

◆ isLinkInternal()

◆ preventClickjacking()

◆ recordOption()

◆ resetParseStartTime()

◆ setCategoryLinks()

◆ setDisplayTitle()

◆ setEditSectionTokens()

◆ setEnableOOUI()

◆ setExtensionData()