MediaWiki  master
ParserOutput Class Reference
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)
 
 addWrapperDivClass ( $class)
 Add a CSS class to use for the wrapping div. More...
 
 clearWrapperDivClass ()
 Clears the CSS class to use for the wrapping div, effectively disabling the wrapper div until addWrapperDivClass() is called. More...
 
 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 ( $options=[])
 Get the output HTML. More...
 
 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. More...
 
 getWarnings ()
 
 getWrapperDivClass ()
 Returns the class (or classes) to be used with the wrapper div for this otuput. More...
 
 hasDynamicContent ()
 Check whether the cache TTL was lowered due to dynamic content. More...
 
 hasText ()
 Returns true if text was passed to the constructor, or set using setText(). More...
 
 hideNewSection ( $value)
 
 mergeHtmlMetaDataFrom (ParserOutput $source)
 Merges HTML metadata such as head items, JS config vars, and HTTP cache control info from $source into this ParserOutput. More...
 
 mergeInternalMetaDataFrom (ParserOutput $source)
 Merges internal metadata such as flags, accessed options, and profiling info from $source into this ParserOutput. More...
 
 mergeTrackingMetaDataFrom (ParserOutput $source)
 Merges dependency tracking metadata such as backlinks, images used, and extension data from $source into this ParserOutput. More...
 
 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)
 
 setNoGallery ( $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
 
 $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 = null
 
 $mTimestamp
 
 $mTitleText
 
 $mTOCHTML = ''
 
 $mWarnings = []
 
const EDITSECTION_REGEX
 
const FAST_AR_TTL = 60
 
const MIN_AR_TTL = 15
 
const PARSE_FAST_SEC = 0.100
 
const PARSE_SLOW_SEC = 1.0
 
const SLOW_AR_TTL = 3600
 
const SUPPORTS_STATELESS_TRANSFORMS = 1
 Feature flags to indicate to extensions that MediaWiki core supports and uses getText() stateless transforms. More...
 
const SUPPORTS_UNWRAP_TRANSFORM = 1
 
- Public Attributes inherited from CacheTime
int null $mCacheExpiry = null
 Seconds after which the object should expire, use 0 for not cacheable. More...
 
int null $mCacheRevisionId = null
 Revision ID that was parsed. More...
 
string int $mCacheTime = ''
 TS_MW timestamp when this object was generated, or -1 for not cacheable. More...
 
string [] $mUsedOptions
 ParserOptions which have been taken into account to produce output. More...
 
string null $mVersion = Parser::VERSION
 Compatibility check. More...
 

Static Private Member Functions

static getTimes ( $clock=null)
 
static merge2D (array $a, array $b)
 
static mergeList (array $a, array $b)
 
static mergeMap (array $a, array $b)
 
static mergeMixedList (array $a, array $b)
 
static useEachMinValue (array $a, array $b)
 
static useMaxValue ( $a, $b)
 
static useMinValue ( $a, $b)
 

Private Attributes

 $mAccessedOptions = []
 
 $mExtensionData = []
 
 $mFlags = []
 
 $mIndexPolicy = ''
 
 $mLimitReportData = []
 
array $mLimitReportJSData = []
 Parser limit report data for JSON. More...
 
int $mMaxAdaptiveExpiry = INF
 Upper bound of expiry based on parse duration. More...
 
 $mParseStartTime = []
 
 $mPreventClickjacking = false
 
int null $mSpeculativeRevId
 Assumed rev ID for {{REVISIONID}} if no revision is set. More...
 
 $mWrapperDivClasses = []
 string CSS classes to use for the wrapping div, stored in the array keys. More...
 

Detailed Description

Definition at line 25 of file ParserOutput.php.

Constructor & Destructor Documentation

◆ __construct()

ParserOutput::__construct (   $text = '',
  $languageLinks = [],
  $categoryLinks = [],
  $unused = false,
  $titletext = '' 
)
Parameters
string | null$textHTML. 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.
array$languageLinks
array$categoryLinks
bool$unused
string$titletext

Definition at line 244 of file ParserOutput.php.

Member Function Documentation

◆ __sleep()

ParserOutput::__sleep ( )

Definition at line 1286 of file ParserOutput.php.

◆ addCategory()

ParserOutput::addCategory (   $c,
  $sort 
)

Definition at line 633 of file ParserOutput.php.

References $sort.

Referenced by addTrackingCategory().

◆ addExternalLink()

ParserOutput::addExternalLink (   $url)

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

References $section.

◆ addImage()

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

Register a file dependency for this output.

Parameters
string$nameTitle dbKey
string | false | null$timestampMW timestamp of file creation (or false if non-existing)
string | false | null$sha1Base 36 SHA-1 of file (or false if non-existing)

Definition at line 757 of file ParserOutput.php.

References $name.

◆ addInterwikiLink()

ParserOutput::addInterwikiLink (   $title)
Parameters
Title$titleTitle object, must be an interwiki link
Exceptions
MWExceptionIf given invalid input

Definition at line 787 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$keysKey or array of key/value pairs.
mixed | null$value[optional] Value of the configuration variable.
Since
1.23

Definition at line 842 of file ParserOutput.php.

References $keys, $value, and as.

Referenced by addOutputPageMetadata().

◆ addLanguageLink()

ParserOutput::addLanguageLink (   $t)

Definition at line 657 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$idOptional known page_id so we can skip the lookup

Definition at line 723 of file ParserOutput.php.

References addInterwikiLink(), Title\getArticleID(), Title\getDBkey(), Title\getNamespace(), Title\isExternal(), NS_FILE, NS_MEDIA, and NS_SPECIAL.

Referenced by WikitextContent\fillParserOutput().

◆ addModules()

ParserOutput::addModules (   $modules)
See also
OutputPage::addModules

Definition at line 816 of file ParserOutput.php.

References $modules, and array().

Referenced by addOutputPageMetadata().

◆ addModuleScripts()

ParserOutput::addModuleScripts (   $modules)
Deprecated:
since 1.31 Use addModules() instead.
See also
OutputPage::addModuleScripts

Definition at line 824 of file ParserOutput.php.

References $modules, and array().

Referenced by addOutputPageMetadata().

◆ addModuleStyles()

ParserOutput::addModuleStyles (   $modules)

◆ addOutputHook()

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

Definition at line 665 of file ParserOutput.php.

◆ addOutputPageMetadata()

◆ addTemplate()

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

Register a template dependency for this output.

Parameters
Title$title
int$page_id
int$rev_id

Definition at line 770 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$msgMessage key
Title$titletitle of the page which is being tracked
Returns
bool Whether the addition was successful
Since
1.25

Definition at line 884 of file ParserOutput.php.

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

◆ addWarning()

ParserOutput::addWarning (   $s)

Definition at line 661 of file ParserOutput.php.

References $s.

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

Referenced by TextContent\fillParserOutput().

◆ finalizeAdaptiveCacheExpiry()

ParserOutput::finalizeAdaptiveCacheExpiry ( )

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

Since
1.28

Definition at line 1266 of file ParserOutput.php.

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

◆ getCategories()

◆ getCategoryLinks()

ParserOutput::getCategoryLinks ( )

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

References $t, and getTitleText().

◆ getEditSectionTokens()

ParserOutput::getEditSectionTokens ( )
Deprecated:
since 1.31 Use getText() options.

Definition at line 482 of file ParserOutput.php.

References wfDeprecated().

◆ getEnableOOUI()

ParserOutput::getEnableOOUI ( )

Definition at line 581 of file ParserOutput.php.

References $mEnableOOUI.

Referenced by OutputPage\addParserOutputMetadata(), and mergeHtmlMetaDataFrom().

◆ 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$keyThe 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 1129 of file ParserOutput.php.

◆ getExternalLinks()

& ParserOutput::getExternalLinks ( )

◆ getFileSearchOptions()

& ParserOutput::getFileSearchOptions ( )

◆ getFlag()

ParserOutput::getFlag (   $flag)

◆ getHeadItems()

ParserOutput::getHeadItems ( )

Definition at line 518 of file ParserOutput.php.

References $mHeadItems.

Referenced by OutputPage\addParserOutputMetadata(), and mergeHtmlMetaDataFrom().

◆ getHideNewSection()

ParserOutput::getHideNewSection ( )

Definition at line 675 of file ParserOutput.php.

References $mHideNewSection.

Referenced by OutputPage\addParserOutputMetadata(), and mergeHtmlMetaDataFrom().

◆ getImages()

& ParserOutput::getImages ( )

Definition at line 499 of file ParserOutput.php.

References $mImages.

Referenced by LinksUpdate\__construct(), and mergeTrackingMetaDataFrom().

◆ getIndexPolicy()

ParserOutput::getIndexPolicy ( )

Definition at line 550 of file ParserOutput.php.

References $mIndexPolicy.

◆ getIndicators()

ParserOutput::getIndicators ( )
Returns
array
Since
1.25

Definition at line 467 of file ParserOutput.php.

References $mIndicators.

Referenced by OutputPage\addParserOutputMetadata(), and mergeHtmlMetaDataFrom().

◆ getInterwikiLinks()

ParserOutput::getInterwikiLinks ( )

Definition at line 451 of file ParserOutput.php.

References $mInterwikiLinks.

Referenced by LinksUpdate\__construct(), and mergeTrackingMetaDataFrom().

◆ getJsConfigVars()

ParserOutput::getJsConfigVars ( )
Returns
array
Since
1.23

Definition at line 538 of file ParserOutput.php.

References $mJsConfigVars.

Referenced by OutputPage\addParserOutputContent(), OutputPage\addParserOutputMetadata(), and mergeHtmlMetaDataFrom().

◆ getLanguageLinks()

& ParserOutput::getLanguageLinks ( )

◆ getLimitReportData()

ParserOutput::getLimitReportData ( )

Definition at line 565 of file ParserOutput.php.

References $mLimitReportData.

◆ getLimitReportJSData()

ParserOutput::getLimitReportJSData ( )

Definition at line 569 of file ParserOutput.php.

References $mLimitReportJSData.

Referenced by OutputPage\addParserOutputMetadata().

◆ getLinks()

& ParserOutput::getLinks ( )

◆ getModules()

ParserOutput::getModules ( )

◆ getModuleScripts()

ParserOutput::getModuleScripts ( )

◆ getModuleStyles()

ParserOutput::getModuleStyles ( )

◆ getNewSection()

ParserOutput::getNewSection ( )

Definition at line 678 of file ParserOutput.php.

References $mNewSection.

Referenced by OutputPage\addParserOutputMetadata(), and mergeHtmlMetaDataFrom().

◆ getNoGallery()

ParserOutput::getNoGallery ( )

Definition at line 514 of file ParserOutput.php.

References $mNoGallery.

Referenced by OutputPage\addParserOutputMetadata(), and mergeHtmlMetaDataFrom().

◆ getOutputHooks()

ParserOutput::getOutputHooks ( )

Definition at line 542 of file ParserOutput.php.

References $mOutputHooks, and array().

Referenced by OutputPage\addParserOutputMetadata(), and mergeInternalMetaDataFrom().

◆ getProperties()

ParserOutput::getProperties ( )

Definition at line 1035 of file ParserOutput.php.

References $mProperties.

Referenced by LinksUpdate\__construct(), and mergeTrackingMetaDataFrom().

◆ getProperty()

ParserOutput::getProperty (   $name)
Parameters
string$nameThe 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 1027 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.

Returns
string
Since
1.27

Definition at line 275 of file ParserOutput.php.

References $mText.

Referenced by WikitextContent\fillParserOutput(), and getText().

◆ getSections()

ParserOutput::getSections ( )

Definition at line 475 of file ParserOutput.php.

References $mSections.

Referenced by mergeHtmlMetaDataFrom().

◆ getSpeculativeRevIdUsed()

ParserOutput::getSpeculativeRevIdUsed ( )
Returns
int|null
Since
1.28

Definition at line 443 of file ParserOutput.php.

References $mSpeculativeRevId.

Referenced by mergeInternalMetaDataFrom(), and Revision\RenderedRevision\outputVariesOnRevisionMetaData().

◆ getTemplateIds()

& ParserOutput::getTemplateIds ( )

Definition at line 495 of file ParserOutput.php.

References $mTemplateIds.

Referenced by OutputPage\addParserOutputMetadata(), and mergeTrackingMetaDataFrom().

◆ getTemplates()

& ParserOutput::getTemplates ( )

◆ getText()

ParserOutput::getText (   $options = [])

Get the output HTML.

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.
  • enableSectionEditLinks: (bool) Include section edit links, assuming section edit link tokens are present in the HTML. Default is true, but might be statefully overridden.
  • 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.
Returns
string HTML
-taint escaped

Definition at line 308 of file ParserOutput.php.

References $context, $options, Sanitizer\decodeCharReferences(), Sanitizer\decodeTagAttributes(), Html\element(), RequestContext\getMain(), getRawText(), getWrapperDivClass(), Title\newFromText(), Html\rawElement(), Hooks\runWithoutAbort(), Parser\TOC_END, Parser\TOC_START, use, and wfUrlencode().

Referenced by OutputPage\addParserOutputText().

◆ getTimes()

static ParserOutput::getTimes (   $clock = null)
staticprivate

Definition at line 1137 of file ParserOutput.php.

References $ret, and wfGetRusage().

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

Referenced by finalizeAdaptiveCacheExpiry().

◆ getTimestamp()

ParserOutput::getTimestamp ( )
Returns
string|null TS_MW timestamp of the revision content

Definition at line 561 of file ParserOutput.php.

References $mTimestamp.

Referenced by mergeInternalMetaDataFrom().

◆ getTitleText()

ParserOutput::getTitleText ( )

Definition at line 471 of file ParserOutput.php.

References $mTitleText.

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

◆ getTOCEnabled()

ParserOutput::getTOCEnabled ( )
Deprecated:
since 1.31 Use getText() options.

Definition at line 576 of file ParserOutput.php.

References wfDeprecated().

◆ getTOCHTML()

ParserOutput::getTOCHTML ( )

Definition at line 554 of file ParserOutput.php.

References $mTOCHTML.

Referenced by OutputPage\addParserOutputMetadata().

◆ getUsedOptions()

ParserOutput::getUsedOptions ( )

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

Returns
string[]

Definition at line 1047 of file ParserOutput.php.

Referenced by ParserCache\save().

◆ getWarnings()

ParserOutput::getWarnings ( )

Definition at line 546 of file ParserOutput.php.

◆ getWrapperDivClass()

ParserOutput::getWrapperDivClass ( )

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

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

Referenced by getText().

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

References $wgParserCacheExpireTime, and CacheTime\getCacheExpiry().

Referenced by 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 263 of file ParserOutput.php.

Referenced by ParserCache\save().

◆ hideNewSection()

ParserOutput::hideNewSection (   $value)

Definition at line 672 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$internalThe server to check against
string$urlThe url to check
Returns
bool

Definition at line 689 of file ParserOutput.php.

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

Referenced by ParserOutputTest\testIsLinkInternal().

◆ merge2D()

static ParserOutput::merge2D ( array  $a,
array  $b 
)
staticprivate

Definition at line 1441 of file ParserOutput.php.

References $keys, and as.

◆ 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 mered into the HTML of this ParserOutput.

Parameters
ParserOutput$source

Definition at line 1341 of file ParserOutput.php.

References getEnableOOUI(), getHeadItems(), getHideNewSection(), getIndicators(), getJsConfigVars(), getModules(), getModuleScripts(), getModuleStyles(), getNewSection(), getNoGallery(), getSections(), and preventClickjacking().

Referenced by ParserOutputTest\testMergeHtmlMetaDataFrom().

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

References getOutputHooks(), getSpeculativeRevIdUsed(), getTimestamp(), useEachMinValue(), useMaxValue(), and wfLogWarning().

Referenced by ParserOutputTest\testMergeInternalMetaDataFrom().

◆ mergeList()

static ParserOutput::mergeList ( array  $a,
array  $b 
)
staticprivate

Definition at line 1433 of file ParserOutput.php.

◆ mergeMap()

static ParserOutput::mergeMap ( array  $a,
array  $b 
)
staticprivate

Definition at line 1437 of file ParserOutput.php.

◆ mergeMixedList()

static ParserOutput::mergeMixedList ( array  $a,
array  $b 
)
staticprivate

Definition at line 1429 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 1399 of file ParserOutput.php.

References getCategories(), getExternalLinks(), getFileSearchOptions(), getImages(), getInterwikiLinks(), getLanguageLinks(), getLinks(), getProperties(), getTemplateIds(), and getTemplates().

Referenced by ParserOutputTest\testMergeTrackingMetaDataFrom().

◆ preventClickjacking()

ParserOutput::preventClickjacking (   $flag = null)

Get or set the prevent-clickjacking flag.

Since
1.24
Parameters
bool | null$flagNew flag value, or null to leave it unchanged
Returns
bool Old flag value

Definition at line 1246 of file ParserOutput.php.

References wfSetVar().

Referenced by OutputPage\addParserOutputMetadata(), and mergeHtmlMetaDataFrom().

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

◆ resetParseStartTime()

ParserOutput::resetParseStartTime ( )

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

Since
1.22

Definition at line 1156 of file ParserOutput.php.

◆ setCategoryLinks()

ParserOutput::setCategoryLinks (   $cl)

Definition at line 593 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$textDesired title text

Definition at line 922 of file ParserOutput.php.

References setProperty(), and setTitleText().

◆ setEditSectionTokens()

ParserOutput::setEditSectionTokens (   $t)
Deprecated:
since 1.31 Use getText() options.

Definition at line 608 of file ParserOutput.php.

References wfDeprecated().

◆ setEnableOOUI()

ParserOutput::setEnableOOUI (   $enable = false)

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

Since
1.26
Parameters
bool$enableIf OOUI should be enabled or not

Definition at line 653 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$keyThe 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$valueThe value to set. Setting a value to null is equivalent to removing the value.

Definition at line 1110 of file ParserOutput.php.

References $value.

◆ setFlag()

ParserOutput::setFlag (   $flag)

Fairly generic flag setter thingy.

Parameters
string$flag

Definition at line 947 of file ParserOutput.php.

Referenced by WikitextContent\fillParserOutput().

◆ setIndexPolicy()

ParserOutput::setIndexPolicy (   $policy)

Definition at line 613 of file ParserOutput.php.

References wfSetVar().

◆ setIndicator()

ParserOutput::setIndicator (   $id,
  $content 
)
Parameters
string$id
string$content
Since
1.25

Definition at line 642 of file ParserOutput.php.

References $content.

◆ setLanguageLinks()

ParserOutput::setLanguageLinks (   $ll)

Definition at line 589 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$keyMessage key
mixed$valueAppropriate for Message::params()

Definition at line 1199 of file ParserOutput.php.

References $name, $value, and list.

◆ setNewSection()

ParserOutput::setNewSection (   $value)

Definition at line 669 of file ParserOutput.php.

References $value.

◆ setNoGallery()

ParserOutput::setNoGallery (   $value)

Definition at line 511 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 (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 = '...';
Parameters
string$name
mixed$value

Definition at line 1015 of file ParserOutput.php.

References $name, and $value.

Referenced by setDisplayTitle().

◆ setSections()

ParserOutput::setSections (   $toc)

Definition at line 601 of file ParserOutput.php.

References wfSetVar().

◆ setSpeculativeRevIdUsed()

ParserOutput::setSpeculativeRevIdUsed (   $id)
Parameters
int$id
Since
1.28

Definition at line 435 of file ParserOutput.php.

◆ setText()

ParserOutput::setText (   $text)

◆ setTimestamp()

ParserOutput::setTimestamp (   $timestamp)

Definition at line 621 of file ParserOutput.php.

References wfSetVar().

Referenced by ParserCache\save().

◆ setTitleText()

ParserOutput::setTitleText (   $t)

Definition at line 597 of file ParserOutput.php.

References $t, and wfSetVar().

Referenced by setDisplayTitle().

◆ setTOCEnabled()

ParserOutput::setTOCEnabled (   $flag)
Deprecated:
since 1.31 Use getText() options.

Definition at line 628 of file ParserOutput.php.

References wfDeprecated().

◆ setTOCHTML()

ParserOutput::setTOCHTML (   $tochtml)

Definition at line 617 of file ParserOutput.php.

References wfSetVar().

◆ unsetProperty()

ParserOutput::unsetProperty (   $name)

Definition at line 1031 of file ParserOutput.php.

References $name.

◆ updateRuntimeAdaptiveExpiry()

ParserOutput::updateRuntimeAdaptiveExpiry (   $ttl)

Lower the runtime adaptive TTL to at most this value.

Parameters
int$ttl
Since
1.28

Definition at line 1256 of file ParserOutput.php.

References CacheTime\updateCacheExpiry().

◆ useEachMinValue()

static ParserOutput::useEachMinValue ( array  $a,
array  $b 
)
staticprivate

Definition at line 1460 of file ParserOutput.php.

References $keys, and as.

Referenced by mergeInternalMetaDataFrom().

◆ useMaxValue()

static ParserOutput::useMaxValue (   $a,
  $b 
)
staticprivate

Definition at line 1487 of file ParserOutput.php.

Referenced by mergeInternalMetaDataFrom().

◆ useMinValue()

static ParserOutput::useMinValue (   $a,
  $b 
)
staticprivate

Definition at line 1475 of file ParserOutput.php.

Member Data Documentation

◆ $mAccessedOptions

ParserOutput::$mAccessedOptions = []
private

Definition at line 182 of file ParserOutput.php.

◆ $mCategories

ParserOutput::$mCategories

Definition at line 47 of file ParserOutput.php.

Referenced by getCategories().

◆ $mEnableOOUI

ParserOutput::$mEnableOOUI = false

Definition at line 172 of file ParserOutput.php.

Referenced by getEnableOOUI().

◆ $mExtensionData

ParserOutput::$mExtensionData = []
private

Definition at line 187 of file ParserOutput.php.

◆ $mExternalLinks

ParserOutput::$mExternalLinks = []

Definition at line 90 of file ParserOutput.php.

Referenced by getExternalLinks().

◆ $mFileSearchOptions

ParserOutput::$mFileSearchOptions = []

Definition at line 85 of file ParserOutput.php.

Referenced by getFileSearchOptions().

◆ $mFlags

ParserOutput::$mFlags = []
private

Definition at line 210 of file ParserOutput.php.

◆ $mHeadItems

ParserOutput::$mHeadItems = []

Definition at line 116 of file ParserOutput.php.

Referenced by getHeadItems().

◆ $mHideNewSection

ParserOutput::$mHideNewSection = false

Definition at line 106 of file ParserOutput.php.

Referenced by getHideNewSection().

◆ $mImages

ParserOutput::$mImages = []

Definition at line 80 of file ParserOutput.php.

Referenced by getImages().

◆ $mIndexPolicy

ParserOutput::$mIndexPolicy = ''
private

Definition at line 177 of file ParserOutput.php.

Referenced by getIndexPolicy().

◆ $mIndicators

ParserOutput::$mIndicators = []

Definition at line 52 of file ParserOutput.php.

Referenced by getIndicators().

◆ $mInterwikiLinks

ParserOutput::$mInterwikiLinks = []

Definition at line 96 of file ParserOutput.php.

Referenced by getInterwikiLinks().

◆ $mJsConfigVars

ParserOutput::$mJsConfigVars = []

Definition at line 136 of file ParserOutput.php.

Referenced by getJsConfigVars().

◆ $mLanguageLinks

ParserOutput::$mLanguageLinks

Definition at line 42 of file ParserOutput.php.

Referenced by getLanguageLinks().

◆ $mLimitReportData

ParserOutput::$mLimitReportData = []
private

Definition at line 192 of file ParserOutput.php.

Referenced by getLimitReportData().

◆ $mLimitReportJSData

array ParserOutput::$mLimitReportJSData = []
private

Parser limit report data for JSON.

Definition at line 195 of file ParserOutput.php.

Referenced by getLimitReportJSData().

◆ $mLinks

ParserOutput::$mLinks = []

Definition at line 63 of file ParserOutput.php.

Referenced by getLinks().

◆ $mMaxAdaptiveExpiry

int ParserOutput::$mMaxAdaptiveExpiry = INF
private

Upper bound of expiry based on parse duration.

Definition at line 221 of file ParserOutput.php.

◆ $mModules

ParserOutput::$mModules = []

Definition at line 121 of file ParserOutput.php.

Referenced by getModules().

◆ $mModuleScripts

ParserOutput::$mModuleScripts = []

Definition at line 126 of file ParserOutput.php.

Referenced by getModuleScripts().

◆ $mModuleStyles

ParserOutput::$mModuleStyles = []

Definition at line 131 of file ParserOutput.php.

Referenced by getModuleStyles().

◆ $mNewSection

ParserOutput::$mNewSection = false

Definition at line 101 of file ParserOutput.php.

Referenced by getNewSection().

◆ $mNoGallery

ParserOutput::$mNoGallery = false

Definition at line 111 of file ParserOutput.php.

Referenced by getNoGallery().

◆ $mOutputHooks

ParserOutput::$mOutputHooks = []

Definition at line 141 of file ParserOutput.php.

Referenced by getOutputHooks().

◆ $mParseStartTime

ParserOutput::$mParseStartTime = []
private

Definition at line 200 of file ParserOutput.php.

◆ $mPreventClickjacking

ParserOutput::$mPreventClickjacking = false
private

Definition at line 205 of file ParserOutput.php.

◆ $mProperties

ParserOutput::$mProperties = []

Definition at line 157 of file ParserOutput.php.

Referenced by getProperties().

◆ $mSections

ParserOutput::$mSections = []

Definition at line 152 of file ParserOutput.php.

Referenced by getSections().

◆ $mSpeculativeRevId

int null ParserOutput::$mSpeculativeRevId
private

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

Definition at line 213 of file ParserOutput.php.

Referenced by getSpeculativeRevIdUsed().

◆ $mTemplateIds

ParserOutput::$mTemplateIds = []

Definition at line 75 of file ParserOutput.php.

Referenced by getTemplateIds().

◆ $mTemplates

ParserOutput::$mTemplates = []

Definition at line 69 of file ParserOutput.php.

Referenced by getTemplates().

◆ $mText

ParserOutput::$mText = null

Definition at line 36 of file ParserOutput.php.

Referenced by getRawText().

◆ $mTimestamp

ParserOutput::$mTimestamp

Definition at line 167 of file ParserOutput.php.

Referenced by getTimestamp().

◆ $mTitleText

ParserOutput::$mTitleText

Definition at line 57 of file ParserOutput.php.

Referenced by getTitleText().

◆ $mTOCHTML

ParserOutput::$mTOCHTML = ''

Definition at line 162 of file ParserOutput.php.

Referenced by getTOCHTML().

◆ $mWarnings

ParserOutput::$mWarnings = []

Definition at line 147 of file ParserOutput.php.

◆ $mWrapperDivClasses

ParserOutput::$mWrapperDivClasses = []
private

string CSS classes to use for the wrapping div, stored in the array keys.

If no class is given, no wrapper is added.

Definition at line 218 of file ParserOutput.php.

◆ EDITSECTION_REGEX

const ParserOutput::EDITSECTION_REGEX
Initial value:
=
'#<(?:mw:)?editsection page="(.*?)" section="(.*?)"(?:/>|>(.*?)(</(?:mw:)?editsection>))#s'

Definition at line 223 of file ParserOutput.php.

Referenced by MediaWiki\Tidy\RaggettWrapper\getWrapped().

◆ FAST_AR_TTL

const ParserOutput::FAST_AR_TTL = 60

Definition at line 231 of file ParserOutput.php.

◆ MIN_AR_TTL

const ParserOutput::MIN_AR_TTL = 15

Definition at line 233 of file ParserOutput.php.

◆ PARSE_FAST_SEC

const ParserOutput::PARSE_FAST_SEC = 0.100

Definition at line 229 of file ParserOutput.php.

◆ PARSE_SLOW_SEC

const ParserOutput::PARSE_SLOW_SEC = 1.0

Definition at line 230 of file ParserOutput.php.

◆ SLOW_AR_TTL

const ParserOutput::SLOW_AR_TTL = 3600

Definition at line 232 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.

Definition at line 30 of file ParserOutput.php.

◆ SUPPORTS_UNWRAP_TRANSFORM

const ParserOutput::SUPPORTS_UNWRAP_TRANSFORM = 1

Definition at line 31 of file ParserOutput.php.


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