Rendered output of a wiki page, as parsed from wikitext. More...

Inherits CacheTime, and ContentMetadataCollector.

Collaboration diagram for ParserOutput:

[legend]

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

	__get ( $name)

	__set ( $name, $value)

	__sleep ()

	__wakeup ()

	addCacheMessage (string $msg)
	Adds a comment notice about cache state to the text of the page.

	addCategory ( $c, $sort='')
	Add a category.

	addExternalLink ( $url)

	addExtraCSPDefaultSrc ( $src)
	Add an extra value to Content-Security-Policy default-src directive.

	addExtraCSPScriptSrc ( $src)
	Add an extra value to Content-Security-Policy script-src directive.

	addExtraCSPStyleSrc ( $src)
	Add an extra value to Content-Security-Policy style-src directive.

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

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

	addInterwikiLink ( $link)

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

	addLanguageLink ( $t)

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

	addModules (array $modules)

	addModuleStyles (array $modules)

	addOutputPageMetadata (OutputPage $out)
	Accommodate very basic transcluding of a temporary OutputPage object into parser output.

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

	addWarningMsg (string $msg,... $args)
	Add a warning to the output for this page.

	addWrapperDivClass ( $class)
	Add a CSS class to use for the wrapping div.

	appendExtensionData (string $key, $value, string $strategy=self::MW_MERGE_STRATEGY_UNION)
	Appends arbitrary data to this ParserObject.

	appendJsConfigVar (string $key, string $value, string $strategy=self::MW_MERGE_STRATEGY_UNION)
	Append a value to a variable to be set in mw.config in JavaScript.

	appendOutputStrings (string $name, array $value)
	Provides a uniform interface to various string sets stored in the ParserOutput.

	clearWrapperDivClass ()
	Clears the CSS class to use for the wrapping div, effectively disabling the wrapper div until addWrapperDivClass() is called.

	collectMetadata (ContentMetadataCollector $metadata)
	Adds the metadata collected in this ParserOutput to the supplied ContentMetadataCollector.

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

	getAllFlags ()

	getCacheMessage ()

&	getCategories ()

	getCategoryMap ()
	Return category names and sort keys as a map.

	getCategoryNames ()
	Return the names of the categories on this page.

	getCategorySortKey (string $name)
	Return the sort key for a given category name, or `null` if the category is not present in this ParserOutput.

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

	getEnableOOUI ()

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

&	getExternalLinks ()

	getExtraCSPDefaultSrcs ()
	Get extra Content-Security-Policy 'default-src' directives.

	getExtraCSPScriptSrcs ()
	Get extra Content-Security-Policy 'script-src' directives.

	getExtraCSPStyleSrcs ()
	Get extra Content-Security-Policy 'style-src' directives.

&	getFileSearchOptions ()

	getFlag ( $flag)

	getHeadItems ()

	getHideNewSection ()

&	getImages ()

	getIndexPolicy ()

	getIndicators ()

	getInterwikiLinks ()

	getJsConfigVars (bool $showStrategyKeys=false)

	getLanguage ()
	Get the primary language code of the output.

&	getLanguageLinks ()

	getLimitReportData ()

	getLimitReportJSData ()

&	getLinks ()

&	getLinksSpecial ()

	getModules ()

	getModuleStyles ()

	getNewSection ()

	getNoGallery ()

	getOutputFlag (string $name)
	Provides a uniform interface to various boolean flags stored in the ParserOutput.

	getOutputStrings (string $name)
	Provides a uniform interface to various boolean string sets stored in the ParserOutput.

	getPageProperties ()
	Return all the page properties set on this ParserOutput.

	getPageProperty (string $name)
	Look up a page property.

	getParsoidRenderId ()

	getPreventClickjacking ()
	Get the prevent-clickjacking flag.

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

	getRedirectHeader ()
	Return an HTML prefix to be applied on redirect pages, or null if this is not a redirect.

	getRevisionTimestampUsed ()

	getRevisionUsedSha1Base36 ()

	getSections ()

	getSpeculativePageIdUsed ()

	getSpeculativeRevIdUsed ()

&	getTemplateIds ()

&	getTemplates ()

	getText ( $options=[])
	Get the output HTML.

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

	getTimestamp ()

	getTitleText ()

	getTOCData ()

	getTOCHTML ()

	getTransformedText ()
	Gets the text set temporarily by output transformations and stored in $mTransformedText.

	getWarnings ()

	getWrapperDivClass ()
	Returns the class (or classes) to be used with the wrapper div for this output.

	hasReducedExpiry ()
	Check whether the cache TTL was lowered from the site default.

	hasText ()
	Returns true if text was passed to the constructor, or set using setText().

	mergeHtmlMetaDataFrom (ParserOutput $source)
	Merges HTML metadata such as head items, JS config vars, and HTTP cache control info from $source into this ParserOutput.

	mergeInternalMetaDataFrom (ParserOutput $source)
	Merges internal metadata such as flags, accessed options, and profiling info from $source into this ParserOutput.

	mergeTrackingMetaDataFrom (ParserOutput $source)
	Merges dependency tracking metadata such as backlinks, images used, and extension data from $source into this ParserOutput.

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

	setCategories (array $c)
	Overwrite the category map.

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

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

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

	setFlag ( $flag)
	Attach a flag to the output so that it can be checked later to handle special cases.

	setHideNewSection (bool $value)

	setIndexPolicy ( $policy)

	setIndicator ( $id, $content)

	setJsConfigVar (string $key, $value)
	Add a variable to be set in mw.config in JavaScript.

	setLanguage (Bcp47Code $lang)
	Set the primary language of the output.

	setLanguageLinks ( $ll)

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

	setNewSection ( $value)

	setNoGallery ( $value)

	setOutputFlag (string $name, bool $val=true)
	Provides a uniform interface to various boolean flags stored in the ParserOutput.

	setPageProperty (string $name, $value)
	Set a page property to be stored in the page_props database table.

	setParsoidRenderId (ParsoidRenderID $parsoidRenderId)

	setPreventClickjacking (bool $flag)
	Set the prevent-clickjacking flag.

	setRedirectHeader (string $html)
	Set an HTML prefix to be applied on redirect pages.

	setRevisionTimestampUsed ( $timestamp)

	setRevisionUsedSha1Base36 ( $hash)

	setSections (array $sectionArray)

	setSpeculativePageIdUsed ( $id)

	setSpeculativeRevIdUsed ( $id)

	setText ( $text)
	Set the text of the ParserOutput.

	setTimestamp ( $timestamp)

	setTitleText ( $t)

	setTOCData (TOCData $tocData)

	setTOCHTML ( $tochtml)

	setTransformedText (string $text)
	Get the text transformed by an output transform.

	unsetPageProperty (string $name)
	Remove a page property.

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

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.

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

	getCacheRevisionId ()

	getCacheTime ()

	getUsedOptions ()
	Returns the options from its ParserOptions which have been taken into account to produce the output.

	isCacheable ()

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

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

	recordOptions (array $options)
	Tags a list of parser option names for use in the cache key for this parser output.

	setCacheRevisionId ( $id)

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

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

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

static	newFromJsonArray (JsonUnserializer $unserializer, array $json)
	Creates a new instance of the class and initialized it from the $json array.

Public Attributes
const	MW_MERGE_STRATEGY_KEY = '_mw-strategy'

const	MW_MERGE_STRATEGY_UNION = 'union'
	Merge strategy to use for ParserOutput accumulators: "union" means that values are strings, stored as a set, and exposed as a PHP associative array mapping from values to `true`.

const	PARSOID_RENDER_ID_KEY = 'parsoid-render-id'

const	SUPPORTS_STATELESS_TRANSFORMS = 1
	Feature flags to indicate to extensions that MediaWiki core supports and uses getText() stateless transforms.

const	SUPPORTS_UNWRAP_TRANSFORM = 1

Protected Member Functions
	initFromJson (JsonUnserializer $unserializer, array $jsonData)
	Initialize member fields from an array returned by jsonSerialize().

	toJsonArray ()
	Returns a JSON serializable structure representing this ParserOutput instance.

Additional Inherited Members
Protected Attributes inherited from CacheTime
int null	$mCacheExpiry = null
	Seconds after which the object should expire, use 0 for not cacheable.

int null	$mCacheRevisionId = null
	Revision ID that was parsed.

string int	$mCacheTime = ''
	TS_MW timestamp when this object was generated, or -1 for not cacheable.

true[]	$mParseUsedOptions = []
	ParserOptions which have been taken into account to produce output, option names stored in array keys.

Detailed Description

Rendered output of a wiki page, as parsed from wikitext.

ParserOutput objects are created by the ParserOutputAccess service, which automatically caches them via ParserCache when possible, and produces new output from the Parser (or Parsoid) as-needed.

Higher-level access is also available via the ContentHandler class, with as its main consumers our APIs and OutputPage/Skin frontend.

Definition at line 50 of file ParserOutput.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

string \| null	$text	HTML. Use null to indicate that this ParserOutput contains only meta-data, and the HTML output is undetermined, as opposed to empty. Passing null here causes hasText() to return false. In 1.39 the default value changed from '' to null.
array	$languageLinks
array	$categoryLinks
bool	$unused
string	$titletext

Definition at line 345 of file ParserOutput.php.

Member Function Documentation

◆ __get()

ParserOutput::__get ( $name )

Reimplemented from CacheTime.

Definition at line 2612 of file ParserOutput.php.

References wfDeprecatedMsg().

◆ __set()

ParserOutput::__set	(	$name,
		$value
	)

Reimplemented from CacheTime.

Definition at line 2627 of file ParserOutput.php.

References wfDeprecatedMsg().

◆ __sleep()

ParserOutput::__sleep ( )

Definition at line 1992 of file ParserOutput.php.

◆ __wakeup()

ParserOutput::__wakeup ( )

Reimplemented from CacheTime.

Definition at line 2594 of file ParserOutput.php.

◆ addCacheMessage()

ParserOutput::addCacheMessage ( string $msg )

Adds a comment notice about cache state to the text of the page.

Parameters

string $msg

Access: internal: used by ParserCache

Definition at line 455 of file ParserOutput.php.

Referenced by MediaWiki\Parser\RevisionOutputCache\save(), and ParserCache\save().

◆ addCategory()

ParserOutput::addCategory	(	$c,
		$sort = `''`
	)

Add a category.

Parameters

string	$c	The category name
string	$sort	The sort key

Definition at line 875 of file ParserOutput.php.

◆ addExternalLink()

ParserOutput::addExternalLink ( $url )

Definition at line 979 of file ParserOutput.php.

◆ addExtraCSPDefaultSrc()

ParserOutput::addExtraCSPDefaultSrc ( $src )

Add an extra value to Content-Security-Policy default-src directive.

Call this if you are including a resource (e.g. image) from a third party domain. This is used for all source types except style and script.

Since: 1.35

Parameters

string $src CSP source e.g. example.com

Definition at line 1941 of file ParserOutput.php.

◆ addExtraCSPScriptSrc()

ParserOutput::addExtraCSPScriptSrc ( $src )

Add an extra value to Content-Security-Policy script-src directive.

Call this if you are loading third-party Javascript

Since: 1.35

Parameters

string $src CSP source e.g. example.com

Definition at line 1963 of file ParserOutput.php.

◆ addExtraCSPStyleSrc()

ParserOutput::addExtraCSPStyleSrc ( $src )

Add an extra value to Content-Security-Policy style-src directive.

Since: 1.35

Parameters

string $src CSP source e.g. example.com

Definition at line 1951 of file ParserOutput.php.

◆ 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 \| false	$tag

Definition at line 1078 of file ParserOutput.php.

◆ addImage()

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

Register a file dependency for this output.

Parameters

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

Definition at line 1036 of file ParserOutput.php.

◆ addInterwikiLink()

ParserOutput::addInterwikiLink ( $link )

Parameters

LinkTarget $link LinkTarget object, must be an interwiki link (used to require Title until 1.38).

Exceptions

MWException If given invalid input

Definition at line 1063 of file ParserOutput.php.

◆ 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 \| null	$value	[optional] Value of the configuration variable.

Since: 1.23

Deprecated:: since 1.38, use ::setJsConfigVar() or ::appendJsConfigVar() which ensures compatibility with asynchronous parsing.

Definition at line 1111 of file ParserOutput.php.

◆ addLanguageLink()

ParserOutput::addLanguageLink ( $t )

Definition at line 908 of file ParserOutput.php.

◆ addLink()

ParserOutput::addLink	(	LinkTarget	$link,
			$id = `null`
	)

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

Parameters

LinkTarget	$link	(used to require Title until 1.38)
int \| null	$id	Optional known page_id so we can skip the lookup

Definition at line 1003 of file ParserOutput.php.

Referenced by WikitextContentHandler\fillParserOutput().

◆ addModules()

ParserOutput::addModules ( array $modules )

See also: OutputPage::addModules

Parameters

string[] $modules

Definition at line 1090 of file ParserOutput.php.

◆ addModuleStyles()

ParserOutput::addModuleStyles ( array $modules )

See also: OutputPage::addModuleStyles

Parameters

string[] $modules

Definition at line 1098 of file ParserOutput.php.

Referenced by JsonContentHandler\fillParserOutput(), and WikitextContentHandler\fillParserOutput().

◆ addOutputPageMetadata()

ParserOutput::addOutputPageMetadata ( OutputPage $out )

Accommodate very basic transcluding of a temporary OutputPage object into parser output.

This is a fragile method that cannot be relied upon in any meaningful way. It exists solely to support the wikitext feature of transcluding a SpecialPage, and only has to work for that use case to ensure relevant styles are loaded, and that essential config vars needed between SpecialPage and a JS feature are added.

This relies on there being no overlap between modules or config vars added by the SpecialPage and those added by parser extensions. If there is overlap, then arise and break one or both sides. This is expected and unsupported.

Access: internal: For use by Parser for basic special page transclusion

Parameters

OutputPage $out

Definition at line 1201 of file ParserOutput.php.

◆ addTemplate()

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

Register a template dependency for this output.

Parameters

LinkTarget	$link	(used to require Title until 1.38)
int	$page_id
int	$rev_id

Definition at line 1050 of file ParserOutput.php.

◆ addWarningMsg()

ParserOutput::addWarningMsg	(	string	$msg,
			$args
	)

Add a warning to the output for this page.

Parameters

string	$msg	The localization message key for the warning
	mixed\|JsonUnserializable	...$args Optional arguments for the message. These arguments must be serializable/unserializable with JsonCodec; see the

Note: on ParserOutput::setExtensionData()

Since: 1.38

Definition at line 920 of file ParserOutput.php.

References wfDeprecatedMsg().

◆ addWrapperDivClass()

ParserOutput::addWrapperDivClass ( $class )

Add a CSS class to use for the wrapping div.

If no class is given, no wrapper is added.

Parameters

string $class

Definition at line 464 of file ParserOutput.php.

◆ appendExtensionData()

ParserOutput::appendExtensionData	(	string	$key,
			$value,
		string	$strategy = `self::MW_MERGE_STRATEGY_UNION`
	)

Appends 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 setPageProperty(), it is not recorded in the database.

See setExtensionData() for more details on rationale and use.

In order to provide for out-of-order/asynchronous/incremental parsing, this method appends values to a set. See setExtensionData() for the flag-like version of this method.

Note: Only values which can be array keys are currently supported as values.

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.
int \| string	$value	The value to append to the list.
string	$strategy	Merge strategy: only MW_MERGE_STRATEGY_UNION is currently supported and external callers should treat this parameter as

Access: internal: at this time and omit it.

Since: 1.38

Definition at line 1746 of file ParserOutput.php.

◆ appendJsConfigVar()

ParserOutput::appendJsConfigVar	(	string	$key,
		string	$value,
		string	$strategy = `self::MW_MERGE_STRATEGY_UNION`
	)

Append a value to a variable to be set in mw.config in JavaScript.

In order to ensure the result is independent of the parse order, the value of this key will be an associative array, mapping all of the values set under that key to true. (The array is implicitly ordered in PHP, but you should treat it as unordered.) If you want a non-array type for the key, and can ensure that only a single value will be set, you should use ::setJsConfigVar() instead.

Parameters

string	$key	Key to use under mw.config
string	$value	Value to append to the configuration variable.
string	$strategy	Merge strategy: only MW_MERGE_STRATEGY_UNION is currently supported and external callers should treat this parameter as

Access: internal: at this time and omit it.

Since: 1.38

Definition at line 1165 of file ParserOutput.php.

◆ appendOutputStrings()

ParserOutput::appendOutputStrings	(	string	$name,
		array	$value
	)

Provides a uniform interface to various string sets stored in the ParserOutput.

String sets internal to MediaWiki core should have names which are constants in ParserOutputStringSets. Extensions should use ::appendExtensionData() rather than creating new string sets with ::appendOutputStrings() in order to prevent namespace conflicts.

Parameters

string	$name	A string set name
string[]	$value

Since: 1.41

Definition at line 1600 of file ParserOutput.php.

◆ clearWrapperDivClass()

ParserOutput::clearWrapperDivClass ( )

Clears the CSS class to use for the wrapping div, effectively disabling the wrapper div until addWrapperDivClass() is called.

Definition at line 472 of file ParserOutput.php.

Referenced by CssContentHandler\fillParserOutput(), JavaScriptContentHandler\fillParserOutput(), and TextContentHandler\fillParserOutput().

◆ collectMetadata()

ParserOutput::collectMetadata ( ContentMetadataCollector $metadata )

Adds the metadata collected in this ParserOutput to the supplied ContentMetadataCollector.

This is similar to ::mergeHtmlMetaDataFrom() but in the opposite direction, since ParserOutput is read/write while ContentMetadataCollector is write-only.

Parameters

ContentMetadataCollector $metadata

Since: 1.38

Definition at line 2163 of file ParserOutput.php.

◆ finalizeAdaptiveCacheExpiry()

ParserOutput::finalizeAdaptiveCacheExpiry ( )

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

Since: 1.28

Definition at line 1972 of file ParserOutput.php.

◆ getAllFlags()

ParserOutput::getAllFlags ( )

Returns: string[] List of flags signifying special cases

Access: internal

Definition at line 1382 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ getCacheMessage()

ParserOutput::getCacheMessage ( )

Access: internal

Returns: string

Definition at line 648 of file ParserOutput.php.

◆ getCategories()

& ParserOutput::getCategories ( )

Deprecated:: since 1.40; use ::getCategoryNames() and ::getCategorySortKey() instead. For

Access: internal: use ::getCategoryMap() may be used, but it is not recommended.

Definition at line 589 of file ParserOutput.php.

References wfDeprecated().

◆ getCategoryMap()

ParserOutput::getCategoryMap ( )

Return category names and sort keys as a map.

BEWARE that numeric category names get converted to 'int' when stored as array keys. Because of this, use of this method is not recommended in new code; using ::getCategoryNames() and ::getCategorySortKey() will be less error-prone.

Returns: array<string|int,string>

Access: internal

Definition at line 605 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ getCategoryNames()

ParserOutput::getCategoryNames ( )

Return the names of the categories on this page.

Unlike ::getCategories(), sort keys are not included in the return value.

Returns: array<string> The names of the categories

Since: 1.38

Definition at line 577 of file ParserOutput.php.

Referenced by MediaWiki\Search\ParserOutputSearchDataExtractor\getCategories(), and MediaWiki\Deferred\LinksUpdate\CategoryLinksTable\setParserOutput().

◆ getCategorySortKey()

ParserOutput::getCategorySortKey ( string $name )

Return the sort key for a given category name, or null if the category is not present in this ParserOutput.

Parameters

string $name The category name

Returns: ?string The sort key for the category, or null if the category is not present in this ParserOutput

Since: 1.40

Definition at line 617 of file ParserOutput.php.

Referenced by MediaWiki\Deferred\LinksUpdate\CategoryLinksTable\setParserOutput().

◆ 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|false HTML

Definition at line 1248 of file ParserOutput.php.

◆ getEnableOOUI()

ParserOutput::getEnableOOUI ( )

Definition at line 771 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ 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 1778 of file ParserOutput.php.

Referenced by MediaWiki\Parser\Parsoid\PageBundleParserOutputConverter\hasPageBundle().

◆ getExternalLinks()

& ParserOutput::getExternalLinks ( )

Definition at line 692 of file ParserOutput.php.

Referenced by MediaWiki\Search\ParserOutputSearchDataExtractor\getExternalLinks(), and MediaWiki\Deferred\LinksUpdate\ExternalLinksTable\setParserOutput().

◆ getExtraCSPDefaultSrcs()

ParserOutput::getExtraCSPDefaultSrcs ( )

Get extra Content-Security-Policy 'default-src' directives.

Since: 1.35

Returns: string[]

Definition at line 780 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ getExtraCSPScriptSrcs()

ParserOutput::getExtraCSPScriptSrcs ( )

Get extra Content-Security-Policy 'script-src' directives.

Since: 1.35

Returns: string[]

Definition at line 789 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ getExtraCSPStyleSrcs()

ParserOutput::getExtraCSPStyleSrcs ( )

Get extra Content-Security-Policy 'style-src' directives.

Since: 1.35

Returns: string[]

Definition at line 798 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ getFileSearchOptions()

& ParserOutput::getFileSearchOptions ( )

Definition at line 688 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ getFlag()

ParserOutput::getFlag ( $flag )

Parameters

string $flag

Returns: bool Whether the given flag was set to signify a special case

Deprecated:: since 1.38; use ::getOutputFlag()

Definition at line 1373 of file ParserOutput.php.

◆ getHeadItems()

ParserOutput::getHeadItems ( )

Definition at line 704 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ getHideNewSection()

ParserOutput::getHideNewSection ( )

Definition at line 952 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ getImages()

& ParserOutput::getImages ( )

Definition at line 684 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputMetadata(), and MediaWiki\Deferred\LinksUpdate\ImageLinksTable\setParserOutput().

◆ getIndexPolicy()

ParserOutput::getIndexPolicy ( )

Definition at line 738 of file ParserOutput.php.

Referenced by Article\getRobotPolicy().

◆ getIndicators()

ParserOutput::getIndicators ( )

Returns: string[]

Since: 1.25

Definition at line 628 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ getInterwikiLinks()

ParserOutput::getInterwikiLinks ( )

Definition at line 566 of file ParserOutput.php.

Referenced by MediaWiki\Deferred\LinksUpdate\InterwikiLinksTable\setParserOutput().

◆ getJsConfigVars()

ParserOutput::getJsConfigVars ( bool $showStrategyKeys = false )

Parameters

bool $showStrategyKeys Defaults to false; if set to true will expose the internal MW_MERGE_STRATEGY_KEY in the result. This should only be used internally to allow safe merge of config vars.

Returns: array

Since: 1.23

Definition at line 723 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputContent(), and MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ getLanguage()

ParserOutput::getLanguage ( )

Get the primary language code of the output.

This returns the primary language of the output, including any LanguageConverter variant applied.

NOTE: This may differ from the wiki's default content language ($wgLanguageCode, MediaWikiServices::getContentLanguage), because each page may have its own "page language" set (PageStoreRecord, Title::getDbPageLanguageCode, ContentHandler::getPageLanguage).

NOTE: This may differ from the "page language" when parsing user interface messages, in which case this reflects the user language (including any variant preference).

NOTE: This may differ from the Parser's "target language" that was set while the Parser was parsing the page, because the final output is converted to the current user's preferred LanguageConverter variant (assuming this is a variant of the target language). See Parser::getTargetLanguageConverter()->getPreferredVariant(); use LanguageFactory::getParentLanguage() on the language code to obtain the base language code. LanguageConverter::getPreferredVariant() depends on the global RequestContext for the URL and the User language preference.

Finally, note that a single ParserOutput object may contain HTML content in multiple different languages and directions (T114640). Authors of wikitext and of parser extensions are expected to mark such subtrees with a lang attribute (set to a BCP-47 value, see Language::toBcp47Code()) and a corresponding dir attribute (see Language::getDir()). This method returns the language code for wrapper of the HTML content.

See also: Parser::internalParseHalfParsed

Since: 1.40

Returns: ?Bcp47Code The primary language for this output, or null if a language was not set.

Definition at line 1294 of file ParserOutput.php.

◆ getLanguageLinks()

& ParserOutput::getLanguageLinks ( )

Definition at line 562 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputMetadata(), and MediaWiki\Deferred\LinksUpdate\LangLinksTable\setParserOutput().

◆ getLimitReportData()

ParserOutput::getLimitReportData ( )

Definition at line 763 of file ParserOutput.php.

◆ getLimitReportJSData()

ParserOutput::getLimitReportJSData ( )

Definition at line 767 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ getLinks()

& ParserOutput::getLinks ( )

Definition at line 664 of file ParserOutput.php.

Referenced by MediaWiki\Search\ParserOutputSearchDataExtractor\getOutgoingLinks(), and MediaWiki\Deferred\LinksUpdate\PageLinksTable\setParserOutput().

◆ getLinksSpecial()

& ParserOutput::getLinksSpecial ( )

Returns: array Keys are DBKs for the links to special pages in the document

Since: 1.35

Definition at line 672 of file ParserOutput.php.

◆ getModules()

ParserOutput::getModules ( )

Definition at line 708 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputContent(), and MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ getModuleStyles()

ParserOutput::getModuleStyles ( )

Definition at line 712 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputContent(), and MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ getNewSection()

ParserOutput::getNewSection ( )

Definition at line 956 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ getNoGallery()

ParserOutput::getNoGallery ( )

Definition at line 700 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ getOutputFlag()

ParserOutput::getOutputFlag ( string $name )

Provides a uniform interface to various boolean flags stored in the ParserOutput.

Flags internal to MediaWiki core should have names which are constants in ParserOutputFlags. Extensions should only use ::getOutputFlag() to query flags defined in ParserOutputFlags in core; they should use getExtensionData() to define their own flags.

Parameters

string $name A flag name

Returns: bool The flag value

Since: 1.38

Definition at line 1560 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ getOutputStrings()

ParserOutput::getOutputStrings ( string $name )

Provides a uniform interface to various boolean string sets stored in the ParserOutput.

String sets internal to MediaWiki core should have names which are constants in ParserOutputStringSets. Extensions should only use ::getOutputStrings() to query string sets defined in ParserOutputStringSets in core; they should use ::appendExtensionData() to define their own string sets.

Parameters

string $name A string set name

Returns: string[] The string set value

Since: 1.41

Definition at line 1640 of file ParserOutput.php.

◆ getPageProperties()

ParserOutput::getPageProperties ( )

Return all the page properties set on this ParserOutput.

Returns: array<string,int|float|string|bool|null>

Since: 1.38

Definition at line 1481 of file ParserOutput.php.

Referenced by MediaWiki\Deferred\LinksUpdate\PagePropsTable\setParserOutput().

◆ getPageProperty()

ParserOutput::getPageProperty ( string $name )

Look up a page property.

Parameters

string $name The page property name to look up.

Returns: int|float|string|bool|null The value previously set using setPageProperty(). Returns null if no value was set for the given property name.

Note: You would need to use ::getPageProperties() to test for an explicitly-set null value; but see the note in ::setPageProperty() about avoiding the use of non-string values.

Since: 1.38

Definition at line 1463 of file ParserOutput.php.

◆ getParsoidRenderId()

ParserOutput::getParsoidRenderId ( )

Access: internal

Return the Parsoid rendering id for this ParserOutput. This is only set where the ParserOutput has been generated by Parsoid.

Returns: string|null

Definition at line 1353 of file ParserOutput.php.

◆ getPreventClickjacking()

ParserOutput::getPreventClickjacking ( )

Get the prevent-clickjacking flag.

Returns: bool Flag value

Since: 1.38

See also: ::setPreventClickjacking

Definition at line 1917 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ 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.

Returns: string

Since: 1.27

Definition at line 376 of file ParserOutput.php.

References $mText.

◆ getRedirectHeader()

ParserOutput::getRedirectHeader ( )

Return an HTML prefix to be applied on redirect pages, or null if this is not a redirect.

Returns: ?string HTML to prepend to redirect pages, or null

Access: internal

Definition at line 1321 of file ParserOutput.php.

◆ getRevisionTimestampUsed()

ParserOutput::getRevisionTimestampUsed ( )

Returns: string|null TS_MW timestamp or null if not used

Since: 1.34

Definition at line 531 of file ParserOutput.php.

◆ getRevisionUsedSha1Base36()

ParserOutput::getRevisionUsedSha1Base36 ( )

Returns: string|null Lowercase SHA-1 base 36 hash, null if unused, or "" on inconsistency

Since: 1.34

Definition at line 558 of file ParserOutput.php.

◆ getSections()

ParserOutput::getSections ( )

Access: internal

Returns: array

Definition at line 656 of file ParserOutput.php.

◆ getSpeculativePageIdUsed()

ParserOutput::getSpeculativePageIdUsed ( )

Returns: int|null

Since: 1.34

Definition at line 515 of file ParserOutput.php.

◆ getSpeculativeRevIdUsed()

ParserOutput::getSpeculativeRevIdUsed ( )

Returns: int|null

Since: 1.28

Definition at line 499 of file ParserOutput.php.

◆ getTemplateIds()

& ParserOutput::getTemplateIds ( )

Definition at line 680 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ getTemplates()

& ParserOutput::getTemplates ( )

Definition at line 676 of file ParserOutput.php.

Referenced by MediaWiki\Search\ParserOutputSearchDataExtractor\getTemplates(), and MediaWiki\Deferred\LinksUpdate\TemplateLinksTable\setParserOutput().

◆ getText()

ParserOutput::getText ( $options = [] )

Get the output HTML.

T293512: in the future, ParserOutput::getText() will be deprecated in favor of invoking the ParserOutputTransform pipeline directly on a ParserOutput.

Parameters

array

$options

(since 1.31) Transformations to apply to the HTML

allowTOC: (bool) Show the TOC, assuming there were enough headings to generate one and __NOTOC__ wasn't used. Default is true, but might be statefully overridden.
injectTOC: (bool) Replace the TOC_PLACEHOLDER with TOC contents; otherwise the marker will be left in the article (and the skin will be responsible for replacing or removing it). Default is true.
enableSectionEditLinks: (bool) Include section edit links, assuming section edit link tokens are present in the HTML. Default is true, but might be statefully overridden.
userLang: (Language) Language object used for localizing UX messages, for example the heading of the table of contents. If omitted, will use the language of the main request context.
skin: (Skin) Skin object used for transforming section edit links.
unwrap: (bool) Return text without a wrapper div. Default is false, meaning a wrapper div will be added if getWrapperDivClass() returns a non-empty string.
wrapperDivClass: (string) Wrap the output in a div and apply the given CSS class to that div. This overrides the output of getWrapperDivClass(). Setting this to an empty string has the same effect as 'unwrap' => true.
deduplicateStyles: (bool) When true, which is the default, <style> tags with the data-mw-deduplicate attribute set are deduplicated by value of the attribute: all but the first will be replaced by <link rel="mw-deduplicated-inline-style" href="mw-data:..."/> tags, where the scheme-specific-part of the href is the (percent-encoded) value of the data-mw-deduplicate attribute.
absoluteURLs: (bool) use absolute URLs in all links. Default: false
includeDebugInfo: (bool) render PP limit report in HTML. Default: false
bodyContentOnly: (bool) . Default: true

Returns: string HTML

Definition at line 445 of file ParserOutput.php.

Referenced by MediaWiki\Status\StatusFormatter\getHTML(), and Message\parseText().

◆ getTimeSinceStart()

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 1819 of file ParserOutput.php.

Referenced by MediaWiki\Parser\Parsoid\ParsoidParser\makeLimitReport().

◆ getTimestamp()

ParserOutput::getTimestamp ( )

Returns: string|null TS_MW timestamp of the revision content

Definition at line 759 of file ParserOutput.php.

◆ getTitleText()

ParserOutput::getTitleText ( )

Definition at line 632 of file ParserOutput.php.

Referenced by Article\adjustDisplayTitle().

◆ getTOCData()

ParserOutput::getTOCData ( )

Returns: ?TOCData the table of contents data, or null if it hasn't been set.

Definition at line 640 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ getTOCHTML()

ParserOutput::getTOCHTML ( )

Deprecated:: since 1.40; use ::getTOCData() instead

Definition at line 751 of file ParserOutput.php.

References wfDeprecated().

◆ getTransformedText()

ParserOutput::getTransformedText ( )

Gets the text set temporarily by output transformations and stored in $mTransformedText.

If the text has not been transformed yet, returns the raw text $mText.

Returns: string

Access: internal

Definition at line 391 of file ParserOutput.php.

◆ getWarnings()

ParserOutput::getWarnings ( )

Definition at line 734 of file ParserOutput.php.

◆ getWrapperDivClass()

ParserOutput::getWrapperDivClass ( )

Returns the class (or classes) to be used with the wrapper div for this output.

If there is no wrapper class given, no wrapper div should be added. The wrapper div is added automatically by getText().

Returns: string

Definition at line 483 of file ParserOutput.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ hasReducedExpiry()

ParserOutput::hasReducedExpiry ( )

Check whether the cache TTL was lowered from the site default.

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.

This method mainly exists to facilitate the logic in WikiPage::triggerOpportunisticLinksUpdate. As such, beware that reducing the TTL for reasons that do not relate to "dynamic content", may have the side-effect of incurring more RefreshLinksJob executions.

Access: internal: For use by Parser and WikiPage

Since: 1.37

Returns: bool

Definition at line 1887 of file ParserOutput.php.

Referenced by MediaWiki\Parser\Parsoid\ParsoidParser\makeLimitReport(), and WikiPage\triggerOpportunisticLinksUpdate().

◆ hasText()

ParserOutput::hasText ( )

Returns true if text was passed to the constructor, or set using setText().

Returns false if null was passed to the $text parameter of the constructor to indicate that this ParserOutput only contains meta-data, and the HTML output is undetermined.

Since: 1.32

Returns: bool Whether this ParserOutput contains rendered text. If this returns false, the ParserOutput contains meta-data only.

Definition at line 364 of file ParserOutput.php.

Referenced by MediaWiki\Parser\RevisionOutputCache\save(), and ParserCache\save().

◆ initFromJson()

ParserOutput::initFromJson	(	JsonUnserializer	$unserializer,
		array	$jsonData
	)

protected

Initialize member fields from an array returned by jsonSerialize().

Parameters

JsonUnserializer	$unserializer
array	$jsonData

Reimplemented from CacheTime.

Definition at line 2483 of file ParserOutput.php.

◆ 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

Access: internal

Definition at line 968 of file ParserOutput.php.

◆ mergeHtmlMetaDataFrom()

ParserOutput::mergeHtmlMetaDataFrom ( ParserOutput $source )

Merges HTML metadata such as head items, JS config vars, and HTTP cache control info from $source into this ParserOutput.

This should be used whenever the HTML in $source has been somehow merged into the HTML of this ParserOutput.

Parameters

ParserOutput $source

Definition at line 2047 of file ParserOutput.php.

Referenced by MediaWiki\Parser\Parsoid\PageBundleParserOutputConverter\parserOutputFromPageBundle().

◆ mergeInternalMetaDataFrom()

ParserOutput::mergeInternalMetaDataFrom ( ParserOutput $source )

Merges internal metadata such as flags, accessed options, and profiling info from $source into this ParserOutput.

This should be used whenever the state of $source has any impact on the state of this ParserOutput.

Parameters

ParserOutput $source

Definition at line 2012 of file ParserOutput.php.

◆ mergeTrackingMetaDataFrom()

ParserOutput::mergeTrackingMetaDataFrom ( ParserOutput $source )

Merges dependency tracking metadata such as backlinks, images used, and extension data from $source into this ParserOutput.

This allows dependency tracking to be done for the combined output of multiple content slots.

Parameters

ParserOutput $source

Definition at line 2125 of file ParserOutput.php.

◆ newFromJsonArray()

static ParserOutput::newFromJsonArray	(	JsonUnserializer	$unserializer,
		array	$json
	)

static

Creates a new instance of the class and initialized it from the $json array.

Parameters

JsonUnserializer	$unserializer	an instance of JsonUnserializer to use for nested properties if they need special care.
array	$json

Returns: JsonUnserializable

Reimplemented from CacheTime.

Definition at line 2472 of file ParserOutput.php.

◆ resetParseStartTime()

ParserOutput::resetParseStartTime ( )

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

Since: 1.22

Definition at line 1804 of file ParserOutput.php.

◆ setCategories()

ParserOutput::setCategories ( array $c )

Overwrite the category map.

Parameters

array<string,string> $c Map of category names to sort keys

Since: 1.38

Definition at line 884 of file ParserOutput.php.

◆ 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 1235 of file ParserOutput.php.

◆ setEnableOOUI()

ParserOutput::setEnableOOUI ( bool $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 904 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 setPageProperty(), 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 = '...';

Note: Only scalar values, e.g. numbers, strings, arrays or MediaWiki\Json\JsonUnserializable instances are supported as a value. Attempt to set other class instance as extension data will break ParserCache for the page.; Since MW 1.38 the practice of setting conflicting values for the same key has been deprecated. As with ::setJsConfigVar(), if you set the same key multiple times on a ParserOutput, it is expected that the value will be identical each time. If you want to collect multiple pieces of data under a single key, use ::appendExtensionData().

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 \| JsonUnserializable	$value	The value to set. Setting a value to null is equivalent to removing the value.

Since: 1.21

Definition at line 1706 of file ParserOutput.php.

◆ setFlag()

ParserOutput::setFlag ( $flag )

Attach a flag to the output so that it can be checked later to handle special cases.

Parameters

string $flag

Deprecated:: since 1.38; use ::setOutputFlag()

Definition at line 1363 of file ParserOutput.php.

◆ setHideNewSection()

ParserOutput::setHideNewSection ( bool $value )

Parameters

bool $value Hide the new section link?

Definition at line 948 of file ParserOutput.php.

◆ setIndexPolicy()

ParserOutput::setIndexPolicy ( $policy )

Definition at line 843 of file ParserOutput.php.

◆ setIndicator()

ParserOutput::setIndicator	(	$id,
		$content
	)

Parameters

string	$id
string	$content

Since: 1.25

Definition at line 893 of file ParserOutput.php.

◆ setJsConfigVar()

ParserOutput::setJsConfigVar	(	string	$key,
			$value
	)

Add a variable to be set in mw.config in JavaScript.

In order to ensure the result is independent of the parse order, the values set here must be unique – that is, you can pass the same $key multiple times but ONLY if the $value is identical each time. If you want to collect multiple pieces of data under a single key, use ::appendJsConfigVar().

Parameters

string	$key	Key to use under mw.config
mixed \| null	$value	Value of the configuration variable.

Since: 1.38

Definition at line 1135 of file ParserOutput.php.

◆ setLanguage()

ParserOutput::setLanguage ( Bcp47Code $lang )

Set the primary language of the output.

See the discussion and caveats in ::getLanguage().

Parameters

Bcp47Code $lang The primary language for this output, including any variant specification.

Since: 1.40

Definition at line 1311 of file ParserOutput.php.

◆ setLanguageLinks()

ParserOutput::setLanguageLinks ( $ll )

Deprecated:: since 1.42, use ::addLanguageLink() instead.

Definition at line 818 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 display in the "NewPP limit report" comment.

Since: 1.22

Parameters

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

Definition at line 1847 of file ParserOutput.php.

Referenced by MediaWiki\Parser\Parsoid\ParsoidParser\makeLimitReport().

◆ setNewSection()

ParserOutput::setNewSection ( $value )

Definition at line 941 of file ParserOutput.php.

◆ setNoGallery()

ParserOutput::setNoGallery ( $value )

Definition at line 696 of file ParserOutput.php.

◆ setOutputFlag()

ParserOutput::setOutputFlag	(	string	$name,
		bool	$val = `true`
	)

Provides a uniform interface to various boolean flags stored in the ParserOutput.

Flags internal to MediaWiki core should have names which are constants in ParserOutputFlags. Extensions should use setExtensionData() rather than creating new flags with ::setOutputFlag() in order to prevent namespace conflicts.

Flags are always combined with OR. That is, the flag is set in the resulting ParserOutput if the flag is set in any of the fragments composing the ParserOutput.

Note: The combination policy means that a ParserOutput may end up with both INDEX_POLICY and NO_INDEX_POLICY set. It is expected that NO_INDEX_POLICY "wins" in that case. (T16899) (This resolution is implemented in ::getIndexPolicy().)

Parameters

string	$name	A flag name
bool	$val

Since: 1.38

Definition at line 1508 of file ParserOutput.php.

Referenced by WikitextContentHandler\fillParserOutput().

◆ setPageProperty()

ParserOutput::setPageProperty	(	string	$name,
			$value
	)

Set a page 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.

setPageProperty() 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 page property.
Overriding the displayed article title (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: It is strongly recommended that only strings be used for $value. Although any JSON-serializable value can be stored/fetched in ParserOutput, when the values are stored to the database (in deferred/LinksUpdate/PagePropsTable.php) they will be stringified: booleans will be converted to '0' and '1', null will become '', and everything else will be cast to string. Page properties obtained from the PageProps service will always be strings.; Do not use setPageProperty() 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 should 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' );

Parameters

string	$name
int \| float \| string \| bool \| null	$value

Since: 1.38

Definition at line 1448 of file ParserOutput.php.

◆ setParsoidRenderId()

ParserOutput::setParsoidRenderId ( ParsoidRenderID $parsoidRenderId )

Access: internal

Store a unique rendering id for this output. This is used by the REST API for stashing content to support editing use cases.

Parameters

ParsoidRenderID $parsoidRenderId

Definition at line 1341 of file ParserOutput.php.

◆ setPreventClickjacking()

ParserOutput::setPreventClickjacking ( bool $flag )

Set the prevent-clickjacking flag.

If set this will cause an X-Frame-Options header appropriate for edit pages to be sent. The header value is controlled by $wgEditPageFrameOptions.

This is the default for special pages. If you display a CSRF-protected form on an ordinary view page, then you need to call this function with $flag = true.

Parameters

bool $flag New flag value

Since: 1.38

Definition at line 1906 of file ParserOutput.php.

◆ setRedirectHeader()

ParserOutput::setRedirectHeader ( string $html )

Set an HTML prefix to be applied on redirect pages.

Parameters

string $html HTML to prepend to redirect pages

Definition at line 1329 of file ParserOutput.php.

Referenced by WikitextContentHandler\fillParserOutput().

◆ setRevisionTimestampUsed()

ParserOutput::setRevisionTimestampUsed ( $timestamp )

Parameters

string $timestamp TS_MW timestamp

Since: 1.34

Definition at line 523 of file ParserOutput.php.

◆ setRevisionUsedSha1Base36()

ParserOutput::setRevisionUsedSha1Base36 ( $hash )

Parameters

string $hash Lowercase SHA-1 base 36 hash

Since: 1.34

Definition at line 539 of file ParserOutput.php.

◆ setSections()

ParserOutput::setSections ( array $sectionArray )

Parameters

array $sectionArray

Returns: array Previous value of ::getSections()

Definition at line 837 of file ParserOutput.php.

◆ setSpeculativePageIdUsed()

ParserOutput::setSpeculativePageIdUsed ( $id )

Parameters

int $id

Since: 1.34

Definition at line 507 of file ParserOutput.php.

◆ setSpeculativeRevIdUsed()

ParserOutput::setSpeculativeRevIdUsed ( $id )

Parameters

int $id

Since: 1.28

Definition at line 491 of file ParserOutput.php.

◆ setText()

ParserOutput::setText ( $text )

Set the text of the ParserOutput.

If you did not generate html, pass null to mark it as such.

Since: 1.39 You can now pass null to this function

Parameters

string | null $text HTML content of ParserOutput or null if not generated

Returns: string|null Previous value of ParserOutput's text

Definition at line 811 of file ParserOutput.php.

References wfSetVar().

Referenced by CssContentHandler\fillParserOutput(), FallbackContentHandler\fillParserOutput(), JavaScriptContentHandler\fillParserOutput(), TextContentHandler\fillParserOutput(), JsonContentHandler\fillParserOutput(), WikitextContentHandler\fillParserOutput(), MediaWiki\Pager\TablePager\getBodyOutput(), and MediaWiki\Pager\TablePager\getFullOutput().

◆ setTimestamp()

ParserOutput::setTimestamp ( $timestamp )

Definition at line 866 of file ParserOutput.php.

References wfSetVar().

Referenced by MediaWiki\Parser\RevisionOutputCache\save().

◆ setTitleText()

ParserOutput::setTitleText ( $t )

Definition at line 822 of file ParserOutput.php.

References wfSetVar().

◆ setTOCData()

ParserOutput::setTOCData ( TOCData $tocData )

Parameters

TOCData $tocData Table of contents data for the page

Definition at line 829 of file ParserOutput.php.

Referenced by MediaWiki\Specials\SpecialVersion\execute(), and MediaWiki\Specials\SpecialEditWatchlist\executeViewEditWatchlist().

◆ setTOCHTML()

ParserOutput::setTOCHTML ( $tochtml )

Access: internal

Deprecated:: since 1.40 T293513: We can remove this once we get rid of MW 1.38 and older parsercache serialization tests since those serialized files have artificial TOC data (which we cannot replicate via on-demand TOC generation).

Definition at line 861 of file ParserOutput.php.

References wfDeprecated(), and wfSetVar().

◆ setTransformedText()

ParserOutput::setTransformedText ( string $text )

Get the text transformed by an output transform.

Access: internal

Definition at line 403 of file ParserOutput.php.

◆ toJsonArray()

ParserOutput::toJsonArray ( )

protected

Returns a JSON serializable structure representing this ParserOutput instance.

See also: newFromJson()

Returns: array

Reimplemented from CacheTime.

Definition at line 2395 of file ParserOutput.php.

◆ unsetPageProperty()

ParserOutput::unsetPageProperty ( string $name )

Remove a page property.

Parameters

string $name The page property name.

Since: 1.38

Definition at line 1472 of file ParserOutput.php.

◆ updateRuntimeAdaptiveExpiry()

ParserOutput::updateRuntimeAdaptiveExpiry ( $ttl )

Lower the runtime adaptive TTL to at most this value.

Parameters

int $ttl

Since: 1.28

Definition at line 1927 of file ParserOutput.php.

Member Data Documentation

◆ MW_MERGE_STRATEGY_KEY

const ParserOutput::MW_MERGE_STRATEGY_KEY = '_mw-strategy'

Access: internal

Since: 1.38

Definition at line 75 of file ParserOutput.php.

◆ MW_MERGE_STRATEGY_UNION

const ParserOutput::MW_MERGE_STRATEGY_UNION = 'union'

Merge strategy to use for ParserOutput accumulators: "union" means that values are strings, stored as a set, and exposed as a PHP associative array mapping from values to true.

This constant should be treated as

Access: internal: until we expose alternative merge strategies for external use.

Access: internal

Since: 1.38

Definition at line 87 of file ParserOutput.php.

◆ PARSOID_RENDER_ID_KEY

const ParserOutput::PARSOID_RENDER_ID_KEY = 'parsoid-render-id'

Access: internal: String Key used to store the parsoid render ID in ParserOutput

Definition at line 93 of file ParserOutput.php.

◆ SUPPORTS_STATELESS_TRANSFORMS

const ParserOutput::SUPPORTS_STATELESS_TRANSFORMS = 1

Feature flags to indicate to extensions that MediaWiki core supports and uses getText() stateless transforms.

Since: 1.31

Definition at line 64 of file ParserOutput.php.

◆ SUPPORTS_UNWRAP_TRANSFORM

const ParserOutput::SUPPORTS_UNWRAP_TRANSFORM = 1

Since: 1.31

Definition at line 69 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

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __get()

◆ __set()

◆ __sleep()

◆ __wakeup()

◆ addCacheMessage()

◆ addCategory()

◆ addExternalLink()

◆ addExtraCSPDefaultSrc()

◆ addExtraCSPScriptSrc()

◆ addExtraCSPStyleSrc()

◆ addHeadItem()

◆ addImage()

◆ addInterwikiLink()

◆ addJsConfigVars()

◆ addLanguageLink()

◆ addLink()

◆ addModules()

◆ addModuleStyles()

◆ addOutputPageMetadata()

◆ addTemplate()

◆ addWarningMsg()

◆ addWrapperDivClass()

◆ appendExtensionData()

◆ appendJsConfigVar()

◆ appendOutputStrings()

◆ clearWrapperDivClass()

◆ collectMetadata()

◆ finalizeAdaptiveCacheExpiry()

◆ getAllFlags()

◆ getCacheMessage()

◆ getCategories()

◆ getCategoryMap()

◆ getCategoryNames()

◆ getCategorySortKey()

◆ getDisplayTitle()

◆ getEnableOOUI()

◆ getExtensionData()

◆ getExternalLinks()

◆ getExtraCSPDefaultSrcs()

◆ getExtraCSPScriptSrcs()

◆ getExtraCSPStyleSrcs()

◆ getFileSearchOptions()

◆ getFlag()

◆ getHeadItems()

◆ getHideNewSection()

◆ getImages()

◆ getIndexPolicy()

◆ getIndicators()

◆ getInterwikiLinks()

◆ getJsConfigVars()

◆ getLanguage()

◆ getLanguageLinks()

◆ getLimitReportData()

◆ getLimitReportJSData()

◆ getLinks()

◆ getLinksSpecial()

◆ getModules()

◆ getModuleStyles()

◆ getNewSection()

◆ getNoGallery()

◆ getOutputFlag()

◆ getOutputStrings()

◆ getPageProperties()

◆ getPageProperty()

◆ getParsoidRenderId()

◆ getPreventClickjacking()

◆ getRawText()

◆ getRedirectHeader()

◆ getRevisionTimestampUsed()

◆ getRevisionUsedSha1Base36()

◆ getSections()