MediaWiki  master
ParserOutput Class Reference
Inheritance diagram for ParserOutput:
Collaboration diagram for ParserOutput:

Public Member Functions

 __construct ( $text='', $languageLinks=[], $categoryLinks=[], $unused=false, $titletext='')
 
 __sleep ()
 
 addCacheMessage (string $msg)
 Adds a comment notice about cache state to the text of the page. More...
 
 addCategory ( $c, $sort)
 
 addExternalLink ( $url)
 
 addExtraCSPDefaultSrc ( $src)
 Add an extra value to Content-Security-Policy default-src directive. More...
 
 addExtraCSPScriptSrc ( $src)
 Add an extra value to Content-Security-Policy script-src directive. More...
 
 addExtraCSPStyleSrc ( $src)
 Add an extra value to Content-Security-Policy style-src directive. More...
 
 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)
 
 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...
 
 getAllFlags ()
 
getCategories ()
 
 getCategoryLinks ()
 
 getDisplayTitle ()
 Get the title to be used for display. More...
 
 getEnableOOUI ()
 
 getExtensionData ( $key)
 Gets extensions data previously attached to this ParserOutput using setExtensionData(). More...
 
getExternalLinks ()
 
 getExtraCSPDefaultSrcs ()
 Get extra Content-Security-Policy 'default-src' directives. More...
 
 getExtraCSPScriptSrcs ()
 Get extra Content-Security-Policy 'script-src' directives. More...
 
 getExtraCSPStyleSrcs ()
 Get extra Content-Security-Policy 'style-src' directives. More...
 
getFileSearchOptions ()
 
 getFlag ( $flag)
 
 getHeadItems ()
 
 getHideNewSection ()
 
getImages ()
 
 getIndexPolicy ()
 
 getIndicators ()
 
 getInterwikiLinks ()
 
 getJsConfigVars ()
 
getLanguageLinks ()
 
 getLimitReportData ()
 
 getLimitReportJSData ()
 
getLinks ()
 
getLinksSpecial ()
 
 getModules ()
 
 getModuleStyles ()
 
 getNewSection ()
 
 getNoGallery ()
 
 getOutputHooks ()
 
 getProperties ()
 
 getProperty ( $name)
 
 getRawText ()
 Get the cacheable text with <mw:editsection> markers still in it. More...
 
 getRevisionTimestampUsed ()
 
 getRevisionUsedSha1Base36 ()
 
 getSections ()
 
 getSpeculativePageIdUsed ()
 
 getSpeculativeRevIdUsed ()
 
getTemplateIds ()
 
getTemplates ()
 
 getText ( $options=[])
 Get the output HTML. More...
 
 getTimeSinceStart ( $clock)
 Returns the time since resetParseStartTime() was last called. More...
 
 getTimestamp ()
 
 getTitleText ()
 
 getTOCHTML ()
 
 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...
 
 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)
 Attach a flag to the output so that it can be checked later to handle special cases. 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...
 
 setRevisionTimestampUsed ( $timestamp)
 
 setRevisionUsedSha1Base36 ( $hash)
 
 setSections ( $toc)
 
 setSpeculativePageIdUsed ( $id)
 
 setSpeculativeRevIdUsed ( $id)
 
 setText ( $text)
 
 setTimestamp ( $timestamp)
 
 setTitleText ( $t)
 
 setTOCHTML ( $tochtml)
 
 unsetProperty ( $name)
 
 updateRuntimeAdaptiveExpiry ( $ttl)
 Lower the runtime adaptive TTL to at most this value. More...
 
- Public Member Functions inherited from CacheTime
 __get ( $name)
 Deprecate access to all public properties. More...
 
 __set ( $name, $value)
 Deprecate access to all public properties. More...
 
 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 ()
 
 getUsedOptions ()
 Returns the options from its ParserOptions which have been taken into account to produce this output. More...
 
 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...
 
 setUsedOptions (array $options)
 Sets the list of accessed ParserOptions which have been taken into account to produce the output stored under this key. 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

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
 

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

array $mCategories
 Map of category names to sort keys. More...
 
bool $mEnableOOUI = false
 Whether OOUI should be enabled. More...
 
array $mExtensionData = []
 extra data used by extensions. More...
 
array $mExternalLinks = []
 External link URLs, in the key only. More...
 
array $mExtraDefaultSrcs = []
 Extra default-src for CSP [Everything but script and style]. More...
 
array $mExtraScriptSrcs = []
 Extra script-src for CSP. More...
 
array $mExtraStyleSrcs = []
 Extra style-src for CSP. More...
 
array $mFileSearchOptions = []
 DB keys of the images used mapped to sha1 and MW timestamp. More...
 
array $mFlags = []
 Generic flags. More...
 
array $mHeadItems = []
 Items to put in the <head> section. More...
 
bool $mHideNewSection = false
 Hide the new section link? More...
 
array $mImages = []
 DB keys of the images used, in the array key only. More...
 
string $mIndexPolicy = ''
 'index' or 'noindex'? Any other value will result in no change. More...
 
array $mIndicators = []
 Page status indicators, usually displayed in top-right corner. More...
 
array $mInterwikiLinks = []
 2-D map of prefix/DBK (in keys only) for the inline interwiki links in the document. More...
 
array $mJsConfigVars = []
 JavaScript config variable for mw.config combined with this page. More...
 
array $mLanguageLinks
 List of the full text of language links, in the order they appear. More...
 
array $mLimitReportData = []
 Parser limit report data. More...
 
array $mLimitReportJSData = []
 Parser limit report data for JSON. More...
 
int[][] $mLinks = []
 2-D map of NS/DBK to ID for the links in the document. More...
 
array $mLinksSpecial = []
 Keys are DBKs for the links to special pages in the document. More...
 
int $mMaxAdaptiveExpiry = INF
 Upper bound of expiry based on parse duration. More...
 
array $mModules = []
 Modules to be loaded by ResourceLoader. More...
 
array $mModuleStyles = []
 Modules of which only the CSS will be loaded by ResourceLoader. More...
 
bool $mNewSection = false
 Show a new section link? More...
 
bool $mNoGallery = false
 No gallery on category page? (NOGALLERY). More...
 
array $mOutputHooks = []
 Hook tags as per $wgParserOutputHooks. More...
 
array $mParseStartTime = []
 Timestamps for getTimeSinceStart(). More...
 
bool $mPreventClickjacking = false
 Whether to emit X-Frame-Options: DENY. More...
 
array $mProperties = []
 Name/value pairs to be cached in the DB. More...
 
array $mSections = []
 Table of contents. More...
 
int null $mSpeculativeRevId
 Assumed rev ID for {{REVISIONID}} if no revision is set. More...
 
array $mTemplateIds = []
 2-D map of NS/DBK to rev ID for the template references. More...
 
array $mTemplates = []
 2-D map of NS/DBK to ID for the template references. More...
 
string null $mText
 The output text. More...
 
string $mTimestamp
 Timestamp of the revision. More...
 
string $mTitleText
 Title text of the chosen language variant, as HTML. More...
 
string $mTOCHTML = ''
 HTML of the TOC. More...
 
array $mWarnings = []
 Warning text to be returned to the user. More...
 
 $mWrapperDivClasses = []
 string CSS classes to use for the wrapping div, stored in the array keys. More...
 
int null $revisionTimestampUsed
 Assumed rev timestamp for {{REVISIONTIMESTAMP}} if no revision is set. More...
 
string null $revisionUsedSha1Base36
 SHA-1 base 36 hash of any self-transclusion. More...
 
int null $speculativePageIdUsed
 Assumed page ID for {{PAGEID}} if no revision is set. More...
 
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
 

Additional Inherited Members

- Protected Attributes inherited from CacheTime
true[] $mAccessedOptions = []
 List of ParserOptions (stored in the keys). More...
 

Detailed Description

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

Member Function Documentation

◆ __sleep()

ParserOutput::__sleep ( )

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

Definition at line 457 of file ParserOutput.php.

Referenced by ParserCache\save().

◆ addCategory()

ParserOutput::addCategory (   $c,
  $sort 
)

Definition at line 750 of file ParserOutput.php.

Referenced by addTrackingCategory().

◆ addExternalLink()

ParserOutput::addExternalLink (   $url)

◆ 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$srcCSP source e.g. example.com

Definition at line 1379 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$srcCSP source e.g. example.com

Definition at line 1401 of file ParserOutput.php.

◆ addExtraCSPStyleSrc()

ParserOutput::addExtraCSPStyleSrc (   $src)

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

Since
1.35
Parameters
string$srcCSP source e.g. example.com

Definition at line 1389 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 | bool$tag

Definition at line 926 of file ParserOutput.php.

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

◆ addInterwikiLink()

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

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

References $keys.

Referenced by addOutputPageMetadata().

◆ addLanguageLink()

ParserOutput::addLanguageLink (   $t)

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

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

Referenced by WikitextContent\fillParserOutput().

◆ addModules()

ParserOutput::addModules (   $modules)
See also
OutputPage::addModules
Parameters
string | array$modules

Definition at line 938 of file ParserOutput.php.

References $modules.

Referenced by addOutputPageMetadata().

◆ addModuleStyles()

ParserOutput::addModuleStyles (   $modules)
See also
OutputPage::addModuleStyles
Parameters
string | array$modules

Definition at line 946 of file ParserOutput.php.

References $modules.

Referenced by addOutputPageMetadata(), JsonContent\fillParserOutput(), and WikitextContent\fillParserOutput().

◆ addOutputHook()

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

Definition at line 782 of file ParserOutput.php.

◆ addOutputPageMetadata()

ParserOutput::addOutputPageMetadata ( OutputPage  $out)

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

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

◆ addWarning()

ParserOutput::addWarning (   $s)

Definition at line 778 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 466 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 474 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 1410 of file ParserOutput.php.

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

◆ getAllFlags()

ParserOutput::getAllFlags ( )
Returns
string[] List of flags signifying special cases
Since
1.34

Definition at line 1078 of file ParserOutput.php.

◆ getCategories()

& ParserOutput::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 1049 of file ParserOutput.php.

References $t, and getTitleText().

◆ getEnableOOUI()

ParserOutput::getEnableOOUI ( )

Definition at line 687 of file ParserOutput.php.

References $mEnableOOUI.

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

◆ getExternalLinks()

& ParserOutput::getExternalLinks ( )

◆ getExtraCSPDefaultSrcs()

ParserOutput::getExtraCSPDefaultSrcs ( )

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

Since
1.35
Returns
array

Definition at line 696 of file ParserOutput.php.

References $mExtraDefaultSrcs.

Referenced by OutputPage\addParserOutputMetadata().

◆ getExtraCSPScriptSrcs()

ParserOutput::getExtraCSPScriptSrcs ( )

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

Since
1.35
Returns
array

Definition at line 705 of file ParserOutput.php.

References $mExtraScriptSrcs.

Referenced by OutputPage\addParserOutputMetadata().

◆ getExtraCSPStyleSrcs()

ParserOutput::getExtraCSPStyleSrcs ( )

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

Since
1.35
Returns
array

Definition at line 714 of file ParserOutput.php.

References $mExtraStyleSrcs.

Referenced by OutputPage\addParserOutputMetadata().

◆ getFileSearchOptions()

& ParserOutput::getFileSearchOptions ( )

Definition at line 620 of file ParserOutput.php.

References $mFileSearchOptions.

Referenced by OutputPage\addParserOutputMetadata().

◆ getFlag()

ParserOutput::getFlag (   $flag)
Parameters
string$flag
Returns
bool Whether the given flag was set to signify a special case

Definition at line 1070 of file ParserOutput.php.

Referenced by Revision\RenderedRevision\outputVariesOnRevisionMetaData(), and MediaWiki\Storage\PageEditStash\storeStashValue().

◆ getHeadItems()

ParserOutput::getHeadItems ( )

Definition at line 636 of file ParserOutput.php.

References $mHeadItems.

Referenced by OutputPage\addParserOutputMetadata().

◆ getHideNewSection()

ParserOutput::getHideNewSection ( )

Definition at line 794 of file ParserOutput.php.

References $mHideNewSection.

Referenced by OutputPage\addParserOutputMetadata().

◆ getImages()

& ParserOutput::getImages ( )

Definition at line 616 of file ParserOutput.php.

References $mImages.

Referenced by LinksUpdate\__construct(), and OutputPage\addParserOutputMetadata().

◆ getIndexPolicy()

ParserOutput::getIndexPolicy ( )

Definition at line 664 of file ParserOutput.php.

References $mIndexPolicy.

◆ getIndicators()

ParserOutput::getIndicators ( )
Returns
array
Since
1.25

Definition at line 584 of file ParserOutput.php.

References $mIndicators.

Referenced by OutputPage\addParserOutputMetadata().

◆ getInterwikiLinks()

ParserOutput::getInterwikiLinks ( )

Definition at line 568 of file ParserOutput.php.

References $mInterwikiLinks.

Referenced by LinksUpdate\__construct().

◆ getJsConfigVars()

ParserOutput::getJsConfigVars ( )
Returns
array
Since
1.23

Definition at line 652 of file ParserOutput.php.

References $mJsConfigVars.

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

◆ getLanguageLinks()

& ParserOutput::getLanguageLinks ( )

Definition at line 564 of file ParserOutput.php.

References $mLanguageLinks.

Referenced by LinksUpdate\__construct(), and OutputPage\addParserOutputMetadata().

◆ getLimitReportData()

ParserOutput::getLimitReportData ( )

Definition at line 679 of file ParserOutput.php.

References $mLimitReportData.

◆ getLimitReportJSData()

ParserOutput::getLimitReportJSData ( )

Definition at line 683 of file ParserOutput.php.

References $mLimitReportJSData.

Referenced by OutputPage\addParserOutputMetadata().

◆ getLinks()

& ParserOutput::getLinks ( )

◆ getLinksSpecial()

& ParserOutput::getLinksSpecial ( )
Returns
array Keys are DBKs for the links to special pages in the document
Since
1.35

Definition at line 604 of file ParserOutput.php.

References $mLinksSpecial.

◆ getModules()

ParserOutput::getModules ( )

Definition at line 640 of file ParserOutput.php.

References $mModules.

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

◆ getModuleStyles()

ParserOutput::getModuleStyles ( )

◆ getNewSection()

ParserOutput::getNewSection ( )

Definition at line 798 of file ParserOutput.php.

References $mNewSection.

Referenced by OutputPage\addParserOutputMetadata().

◆ getNoGallery()

ParserOutput::getNoGallery ( )

Definition at line 632 of file ParserOutput.php.

References $mNoGallery.

Referenced by OutputPage\addParserOutputMetadata().

◆ getOutputHooks()

ParserOutput::getOutputHooks ( )

Definition at line 656 of file ParserOutput.php.

References $mOutputHooks.

Referenced by OutputPage\addParserOutputMetadata().

◆ getProperties()

ParserOutput::getProperties ( )

Definition at line 1162 of file ParserOutput.php.

References $mProperties.

Referenced by LinksUpdate\__construct().

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

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

References $mText.

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

◆ getRevisionTimestampUsed()

ParserOutput::getRevisionTimestampUsed ( )
Returns
string|null TS_MW timestamp or null if not used
Since
1.34

Definition at line 533 of file ParserOutput.php.

References $revisionTimestampUsed.

Referenced by Revision\RenderedRevision\outputVariesOnRevisionMetaData().

◆ getRevisionUsedSha1Base36()

ParserOutput::getRevisionUsedSha1Base36 ( )
Returns
string|null Lowercase SHA-1 base 36 hash, null if unused, or "" on inconsistency
Since
1.34

Definition at line 560 of file ParserOutput.php.

References $revisionUsedSha1Base36.

Referenced by Revision\RenderedRevision\outputVariesOnRevisionMetaData().

◆ getSections()

ParserOutput::getSections ( )

Definition at line 592 of file ParserOutput.php.

References $mSections.

◆ getSpeculativePageIdUsed()

ParserOutput::getSpeculativePageIdUsed ( )
Returns
int|null
Since
1.34

Definition at line 517 of file ParserOutput.php.

References $speculativePageIdUsed.

Referenced by Revision\RenderedRevision\outputVariesOnRevisionMetaData().

◆ getSpeculativeRevIdUsed()

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

Definition at line 501 of file ParserOutput.php.

References $mSpeculativeRevId.

Referenced by Revision\RenderedRevision\outputVariesOnRevisionMetaData().

◆ getTemplateIds()

& ParserOutput::getTemplateIds ( )

Definition at line 612 of file ParserOutput.php.

References $mTemplateIds.

Referenced by OutputPage\addParserOutputMetadata().

◆ 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.
  • 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.
Returns
string HTML
-taint escaped

Definition at line 344 of file ParserOutput.php.

References Sanitizer\decodeCharReferences(), Sanitizer\decodeTagAttributes(), Html\element(), RequestContext\getMain(), getRawText(), getTitleText(), getWrapperDivClass(), Title\newFromText(), Html\rawElement(), Hooks\runner(), Parser\TOC_END, Parser\TOC_START, and wfUrlencode().

Referenced by OutputPage\addParserOutputText(), Status\getHTML(), and Message\parseText().

◆ getTimes()

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

Definition at line 1248 of file ParserOutput.php.

Referenced by getTimeSinceStart(), and resetParseStartTime().

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

References getTimes().

Referenced by finalizeAdaptiveCacheExpiry().

◆ getTimestamp()

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

Definition at line 675 of file ParserOutput.php.

References $mTimestamp.

◆ getTitleText()

ParserOutput::getTitleText ( )

Definition at line 588 of file ParserOutput.php.

References $mTitleText.

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

◆ getTOCHTML()

ParserOutput::getTOCHTML ( )

Definition at line 668 of file ParserOutput.php.

References $mTOCHTML.

Referenced by OutputPage\addParserOutputMetadata().

◆ getWarnings()

ParserOutput::getWarnings ( )

Definition at line 660 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 485 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 1342 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 298 of file ParserOutput.php.

Referenced by ParserCache\save().

◆ hideNewSection()

ParserOutput::hideNewSection (   $value)

Definition at line 790 of file ParserOutput.php.

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

Referenced by addExternalLink().

◆ merge2D()

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

Definition at line 1600 of file ParserOutput.php.

References $keys.

Referenced by mergeTrackingMetaDataFrom().

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

References $source, mergeList(), mergeMap(), and mergeMixedList().

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

References $source, mergeList(), mergeMap(), useEachMinValue(), useMaxValue(), and wfLogWarning().

◆ mergeList()

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

◆ mergeMap()

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

◆ mergeMixedList()

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

Definition at line 1588 of file ParserOutput.php.

Referenced by mergeHtmlMetaDataFrom().

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

References $source, merge2D(), mergeList(), and mergeMap().

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

References wfSetVar().

Referenced by OutputPage\addParserOutputMetadata().

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

◆ resetParseStartTime()

ParserOutput::resetParseStartTime ( )

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

Since
1.22

Definition at line 1265 of file ParserOutput.php.

References getTimes().

◆ setCategoryLinks()

ParserOutput::setCategoryLinks (   $cl)

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

References setProperty(), and setTitleText().

◆ 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 770 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 1225 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

Definition at line 1062 of file ParserOutput.php.

Referenced by WikitextContent\fillParserOutput().

◆ setIndexPolicy()

ParserOutput::setIndexPolicy (   $policy)

Definition at line 738 of file ParserOutput.php.

References wfSetVar().

◆ setIndicator()

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

Definition at line 759 of file ParserOutput.php.

References $content.

◆ setLanguageLinks()

ParserOutput::setLanguageLinks (   $ll)

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

◆ setNewSection()

ParserOutput::setNewSection (   $value)

Definition at line 786 of file ParserOutput.php.

◆ setNoGallery()

ParserOutput::setNoGallery (   $value)

Definition at line 628 of file ParserOutput.php.

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

Referenced by setDisplayTitle().

◆ setRevisionTimestampUsed()

ParserOutput::setRevisionTimestampUsed (   $timestamp)
Parameters
string$timestampTS_MW timestamp
Since
1.34

Definition at line 525 of file ParserOutput.php.

◆ setRevisionUsedSha1Base36()

ParserOutput::setRevisionUsedSha1Base36 (   $hash)
Parameters
string$hashLowercase SHA-1 base 36 hash
Since
1.34

Definition at line 541 of file ParserOutput.php.

◆ setSections()

ParserOutput::setSections (   $toc)

Definition at line 734 of file ParserOutput.php.

References wfSetVar().

◆ setSpeculativePageIdUsed()

ParserOutput::setSpeculativePageIdUsed (   $id)
Parameters
int$id
Since
1.34

Definition at line 509 of file ParserOutput.php.

◆ setSpeculativeRevIdUsed()

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

Definition at line 493 of file ParserOutput.php.

◆ setText()

◆ setTimestamp()

ParserOutput::setTimestamp (   $timestamp)

Definition at line 746 of file ParserOutput.php.

References wfSetVar().

Referenced by ParserCache\save().

◆ setTitleText()

ParserOutput::setTitleText (   $t)

Definition at line 730 of file ParserOutput.php.

References $t, and wfSetVar().

Referenced by setDisplayTitle().

◆ setTOCHTML()

ParserOutput::setTOCHTML (   $tochtml)

Definition at line 742 of file ParserOutput.php.

References wfSetVar().

◆ unsetProperty()

ParserOutput::unsetProperty (   $name)

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

References CacheTime\updateCacheExpiry().

◆ useEachMinValue()

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

Definition at line 1619 of file ParserOutput.php.

References $keys, and useMinValue().

Referenced by mergeInternalMetaDataFrom().

◆ useMaxValue()

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

Definition at line 1646 of file ParserOutput.php.

Referenced by mergeInternalMetaDataFrom().

◆ useMinValue()

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

Definition at line 1634 of file ParserOutput.php.

Referenced by useEachMinValue().

Member Data Documentation

◆ $mCategories

array ParserOutput::$mCategories
private

Map of category names to sort keys.

Definition at line 56 of file ParserOutput.php.

Referenced by getCategories().

◆ $mEnableOOUI

bool ParserOutput::$mEnableOOUI = false
private

Whether OOUI should be enabled.

Definition at line 183 of file ParserOutput.php.

Referenced by getEnableOOUI().

◆ $mExtensionData

array ParserOutput::$mExtensionData = []
private

extra data used by extensions.

Definition at line 193 of file ParserOutput.php.

◆ $mExternalLinks

array ParserOutput::$mExternalLinks = []
private

External link URLs, in the key only.

Definition at line 106 of file ParserOutput.php.

Referenced by getExternalLinks().

◆ $mExtraDefaultSrcs

array ParserOutput::$mExtraDefaultSrcs = []
private

Extra default-src for CSP [Everything but script and style].

Definition at line 221 of file ParserOutput.php.

Referenced by getExtraCSPDefaultSrcs().

◆ $mExtraScriptSrcs

array ParserOutput::$mExtraScriptSrcs = []
private

Extra script-src for CSP.

Definition at line 216 of file ParserOutput.php.

Referenced by getExtraCSPScriptSrcs().

◆ $mExtraStyleSrcs

array ParserOutput::$mExtraStyleSrcs = []
private

Extra style-src for CSP.

Definition at line 226 of file ParserOutput.php.

Referenced by getExtraCSPStyleSrcs().

◆ $mFileSearchOptions

array ParserOutput::$mFileSearchOptions = []
private

DB keys of the images used mapped to sha1 and MW timestamp.

Definition at line 101 of file ParserOutput.php.

Referenced by getFileSearchOptions().

◆ $mFlags

array ParserOutput::$mFlags = []
private

Generic flags.

Definition at line 231 of file ParserOutput.php.

◆ $mHeadItems

array ParserOutput::$mHeadItems = []
private

Items to put in the <head> section.

Definition at line 132 of file ParserOutput.php.

Referenced by getHeadItems().

◆ $mHideNewSection

bool ParserOutput::$mHideNewSection = false
private

Hide the new section link?

Definition at line 122 of file ParserOutput.php.

Referenced by getHideNewSection().

◆ $mImages

array ParserOutput::$mImages = []
private

DB keys of the images used, in the array key only.

Definition at line 96 of file ParserOutput.php.

Referenced by getImages().

◆ $mIndexPolicy

string ParserOutput::$mIndexPolicy = ''
private

'index' or 'noindex'? Any other value will result in no change.

Definition at line 188 of file ParserOutput.php.

Referenced by getIndexPolicy().

◆ $mIndicators

array ParserOutput::$mIndicators = []
private

Page status indicators, usually displayed in top-right corner.

Definition at line 61 of file ParserOutput.php.

Referenced by getIndicators().

◆ $mInterwikiLinks

array ParserOutput::$mInterwikiLinks = []
private

2-D map of prefix/DBK (in keys only) for the inline interwiki links in the document.

Definition at line 112 of file ParserOutput.php.

Referenced by getInterwikiLinks().

◆ $mJsConfigVars

array ParserOutput::$mJsConfigVars = []
private

JavaScript config variable for mw.config combined with this page.

Definition at line 147 of file ParserOutput.php.

Referenced by getJsConfigVars().

◆ $mLanguageLinks

array ParserOutput::$mLanguageLinks
private

List of the full text of language links, in the order they appear.

Definition at line 51 of file ParserOutput.php.

Referenced by getLanguageLinks().

◆ $mLimitReportData

array ParserOutput::$mLimitReportData = []
private

Parser limit report data.

Definition at line 198 of file ParserOutput.php.

Referenced by getLimitReportData().

◆ $mLimitReportJSData

array ParserOutput::$mLimitReportJSData = []
private

Parser limit report data for JSON.

Definition at line 201 of file ParserOutput.php.

Referenced by getLimitReportJSData().

◆ $mLinks

int [][] ParserOutput::$mLinks = []
private

2-D map of NS/DBK to ID for the links in the document.

ID=zero for broken. -var array<int,array<string,int>>

Definition at line 73 of file ParserOutput.php.

Referenced by getLinks().

◆ $mLinksSpecial

array ParserOutput::$mLinksSpecial = []
private

Keys are DBKs for the links to special pages in the document.

Since
1.35

Definition at line 79 of file ParserOutput.php.

Referenced by getLinksSpecial().

◆ $mMaxAdaptiveExpiry

int ParserOutput::$mMaxAdaptiveExpiry = INF
private

Upper bound of expiry based on parse duration.

Definition at line 256 of file ParserOutput.php.

◆ $mModules

array ParserOutput::$mModules = []
private

Modules to be loaded by ResourceLoader.

Definition at line 137 of file ParserOutput.php.

Referenced by getModules().

◆ $mModuleStyles

array ParserOutput::$mModuleStyles = []
private

Modules of which only the CSS will be loaded by ResourceLoader.

Definition at line 142 of file ParserOutput.php.

Referenced by getModuleStyles().

◆ $mNewSection

bool ParserOutput::$mNewSection = false
private

Show a new section link?

Definition at line 117 of file ParserOutput.php.

Referenced by getNewSection().

◆ $mNoGallery

bool ParserOutput::$mNoGallery = false
private

No gallery on category page? (NOGALLERY).

Definition at line 127 of file ParserOutput.php.

Referenced by getNoGallery().

◆ $mOutputHooks

array ParserOutput::$mOutputHooks = []
private

Hook tags as per $wgParserOutputHooks.

Definition at line 152 of file ParserOutput.php.

Referenced by getOutputHooks().

◆ $mParseStartTime

array ParserOutput::$mParseStartTime = []
private

Timestamps for getTimeSinceStart().

Definition at line 206 of file ParserOutput.php.

◆ $mPreventClickjacking

bool ParserOutput::$mPreventClickjacking = false
private

Whether to emit X-Frame-Options: DENY.

Definition at line 211 of file ParserOutput.php.

◆ $mProperties

array ParserOutput::$mProperties = []
private

Name/value pairs to be cached in the DB.

Definition at line 168 of file ParserOutput.php.

Referenced by getProperties().

◆ $mSections

array ParserOutput::$mSections = []
private

Table of contents.

Definition at line 163 of file ParserOutput.php.

Referenced by getSections().

◆ $mSpeculativeRevId

int null ParserOutput::$mSpeculativeRevId
private
Initial value:
=[,,]
private const SPECULATIVE_FIELDS
'speculativePageIdUsed'
'mSpeculativeRevId'
'revisionTimestampUsed'

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

Definition at line 241 of file ParserOutput.php.

Referenced by getSpeculativeRevIdUsed().

◆ $mTemplateIds

array ParserOutput::$mTemplateIds = []
private

2-D map of NS/DBK to rev ID for the template references.

ID=zero for broken.

Definition at line 91 of file ParserOutput.php.

Referenced by getTemplateIds().

◆ $mTemplates

array ParserOutput::$mTemplates = []
private

2-D map of NS/DBK to ID for the template references.

ID=zero for broken.

Definition at line 85 of file ParserOutput.php.

Referenced by getTemplates().

◆ $mText

string null ParserOutput::$mText
private

The output text.

Definition at line 45 of file ParserOutput.php.

Referenced by getRawText().

◆ $mTimestamp

string ParserOutput::$mTimestamp
private

Timestamp of the revision.

Definition at line 178 of file ParserOutput.php.

Referenced by getTimestamp().

◆ $mTitleText

string ParserOutput::$mTitleText
private

Title text of the chosen language variant, as HTML.

Definition at line 66 of file ParserOutput.php.

Referenced by getTitleText().

◆ $mTOCHTML

string ParserOutput::$mTOCHTML = ''
private

HTML of the TOC.

Definition at line 173 of file ParserOutput.php.

Referenced by getTOCHTML().

◆ $mWarnings

array ParserOutput::$mWarnings = []
private

Warning text to be returned to the user.

Wikitext formatted, in the key only.

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

◆ $revisionTimestampUsed

int null ParserOutput::$revisionTimestampUsed
private

Assumed rev timestamp for {{REVISIONTIMESTAMP}} if no revision is set.

Definition at line 245 of file ParserOutput.php.

Referenced by getRevisionTimestampUsed().

◆ $revisionUsedSha1Base36

string null ParserOutput::$revisionUsedSha1Base36
private

SHA-1 base 36 hash of any self-transclusion.

Definition at line 248 of file ParserOutput.php.

Referenced by getRevisionUsedSha1Base36().

◆ $speculativePageIdUsed

int null ParserOutput::$speculativePageIdUsed
private

Assumed page ID for {{PAGEID}} if no revision is set.

Definition at line 243 of file ParserOutput.php.

Referenced by getSpeculativePageIdUsed().

◆ EDITSECTION_REGEX

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

Definition at line 258 of file ParserOutput.php.

◆ FAST_AR_TTL

const ParserOutput::FAST_AR_TTL = 60
private

Definition at line 266 of file ParserOutput.php.

Referenced by finalizeAdaptiveCacheExpiry().

◆ MIN_AR_TTL

const ParserOutput::MIN_AR_TTL = 15
private

Definition at line 268 of file ParserOutput.php.

◆ PARSE_FAST_SEC

const ParserOutput::PARSE_FAST_SEC = 0.100
private

Definition at line 264 of file ParserOutput.php.

◆ PARSE_SLOW_SEC

const ParserOutput::PARSE_SLOW_SEC = 1.0
private

Definition at line 265 of file ParserOutput.php.

◆ SLOW_AR_TTL

const ParserOutput::SLOW_AR_TTL = 3600
private

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

◆ SUPPORTS_UNWRAP_TRANSFORM

const ParserOutput::SUPPORTS_UNWRAP_TRANSFORM = 1
Since
1.31

Definition at line 40 of file ParserOutput.php.


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