MediaWiki REL1_39
|
This is one of the Core classes and should be read at least once by any new developers. More...
Public Member Functions | |
__construct (IContextSource $context) | |
Constructor for OutputPage. | |
adaptCdnTTL ( $mtime, $minTTL=0, $maxTTL=0) | |
Get TTL in [$minTTL,$maxTTL] and pass it to lowerCdnMaxage() | |
addBacklinkSubtitle (PageReference $title, $query=[]) | |
Add a subtitle containing a backlink to a page. | |
addBodyClasses ( $classes) | |
Add a class to the <body> element. | |
addCategoryLinks (array $categories) | |
Add an array of categories, with names in the keys. | |
addContentOverride ( $target, Content $content) | |
Force the given Content object for the given page, for things like page preview. | |
addContentOverrideCallback (callable $callback) | |
Add a callback for mapping from a Title to a Content object, for things like page preview. | |
addElement ( $element, array $attribs=[], $contents='') | |
Shortcut for adding an Html::element via addHTML. | |
addFeedLink ( $format, $href) | |
Add a feed link to the page header. | |
addHeadItem ( $name, $value) | |
Add or replace a head item to the output. | |
addHeadItems ( $values) | |
Add one or more head items to the output. | |
addHelpLink ( $to, $overrideBaseUrl=false) | |
Adds help link with an icon via page indicators. | |
addHTML ( $text) | |
Append $text to the body HTML. | |
addHtmlClasses ( $classes) | |
Add a class to the <html> element. | |
addInlineScript ( $script) | |
Add a self-contained script tag with the given contents Internal use only. | |
addInlineStyle ( $style_css, $flip='noflip') | |
Adds inline CSS styles Internal use only. | |
addJsConfigVars ( $keys, $value=null) | |
Add one or more variables to be set in mw.config in JavaScript. | |
addLanguageLinks (array $newLinkArray) | |
Add new language links. | |
addLink (array $linkarr) | |
Add a new \<link\> tag to the page header. | |
addLinkHeader ( $header) | |
Add an HTTP Link: header. | |
addMeta ( $name, $val) | |
Add a new "<meta>" tag To add an http-equiv meta tag, precede the name with "http:". | |
addModules ( $modules) | |
Load one or more ResourceLoader modules on this page. | |
addModuleStyles ( $modules) | |
Load the styles of one or more style-only ResourceLoader modules on this page. | |
addParserOutput (ParserOutput $parserOutput, $poOptions=[]) | |
Add everything from a ParserOutput object. | |
addParserOutputContent (ParserOutput $parserOutput, $poOptions=[]) | |
Add the HTML and enhancements for it (like ResourceLoader modules) associated with a ParserOutput object, without any other metadata. | |
addParserOutputMetadata (ParserOutput $parserOutput) | |
Add all metadata associated with a ParserOutput object, but without the actual HTML. | |
addParserOutputText (ParserOutput $parserOutput, $poOptions=[]) | |
Add the HTML associated with a ParserOutput object, without any metadata. | |
addReturnTo ( $title, array $query=[], $text=null, $options=[]) | |
Add a "return to" link pointing to a specified title. | |
addScript ( $script) | |
Add raw HTML to the list of scripts (including \<script\> tag, etc.) Internal use only. | |
addScriptFile ( $file, $unused=null) | |
Add a JavaScript file to be loaded as <script> on this page. | |
addStyle ( $style, $media='', $condition='', $dir='') | |
Add a local or specified stylesheet, with the given media options. | |
addSubtitle ( $str) | |
Add $str to the subtitle. | |
addTemplate (&$template) | |
Add the output of a QuickTemplate to the output buffer. | |
addVaryHeader ( $header, array $option=null) | |
Add an HTTP header that will influence on the cache. | |
addWikiMsg (... $args) | |
Add a wikitext-formatted message to the output. | |
addWikiMsgArray ( $name, $args) | |
Add a wikitext-formatted message to the output. | |
addWikiTextAsContent ( $text, $linestart=true, PageReference $title=null) | |
Convert wikitext in the page content language to HTML and add it to the buffer. | |
addWikiTextAsInterface ( $text, $linestart=true, PageReference $title=null) | |
Convert wikitext in the user interface language to HTML and add it to the buffer. | |
allowClickjacking () | |
Turn off frame-breaking. | |
buildCssLinksArray () | |
checkLastModified ( $timestamp) | |
checkLastModified tells the client to use the client-cached page if possible. | |
clearHTML () | |
Clear the body HTML. | |
clearSubtitle () | |
Clear the subtitles. | |
considerCacheSettingsFinal () | |
Set the expectation that cache control will not change after this point. | |
couldBePublicCached () | |
Whether the output might become publicly cached. | |
disable () | |
Disable output completely, i.e. | |
disableClientCache () | |
Force the page to send nocache headers. | |
disallowUserJs () | |
Do not allow scripts which can be modified by wiki users to load on this page; only allow scripts bundled with, or generated by, the software. | |
enableClientCache ( $state) | |
Use enableClientCache(false) to force it to send nocache headers. | |
enableOOUI () | |
Add ResourceLoader module styles for OOUI and set up the PHP implementation of it for use with MediaWiki and this OutputPage instance. | |
forceHideNewSectionLink () | |
Forcibly hide the new section link? | |
formatPermissionsErrorMessage (array $errors, $action=null) | |
Format a list of error messages. | |
formatPermissionStatus (PermissionStatus $status, string $action=null) | |
Format permission $status obtained from Authority for display. | |
getAllowedModules ( $type) | |
Show what level of JavaScript / CSS untrustworthiness is allowed on this page. | |
getArticleBodyOnly () | |
Return whether the output will contain only the body of the article. | |
getBottomScripts () | |
JS stuff to put at the bottom of the <body> . | |
getCacheVaryCookies () | |
Get the list of cookie names that will influence the cache. | |
getCanonicalUrl () | |
Returns the URL to be used for the <link rel=canonical>> if one is set. | |
getCategories ( $type='all') | |
Get the list of category names this page belongs to. | |
getCategoryLinks () | |
Get the list of category links, in a 2-D array with the following format: $arr[$type][] = $link, where $type is either "normal" or "hidden" (for hidden categories) and $link a HTML fragment with a link to the category page. | |
getCSP () | |
Get the ContentSecurityPolicy object. | |
getCSPNonce () | |
Get (and set if not yet set) the CSP nonce. | |
getDisplayTitle () | |
Returns page display title. | |
getFeedAppendQuery () | |
Will currently always return null. | |
getFileSearchOptions () | |
Get the files used on this page. | |
getFileVersion () | |
Get the displayed file version. | |
getFollowPolicy () | |
Get the current follow policy for the page as a string. | |
getFrameOptions () | |
Get the X-Frame-Options header value (without the name part), or false if there isn't one. | |
getHeadItemsArray () | |
Get an array of head items. | |
getHeadLinksArray () | |
getHTML () | |
Get the body HTML. | |
getHTMLTitle () | |
Return the "HTML title", i.e. | |
getIndexPolicy () | |
Get the current index policy for the page as a string. | |
getIndicators () | |
Get the indicators associated with this page. | |
getJsConfigVars () | |
Get the javascript config vars to include on this page. | |
getJSVars () | |
Get an array containing the variables to be set in mw.config in JavaScript. | |
getLanguageLinks () | |
Get the list of language links. | |
getLinkHeader () | |
Return a Link: header. | |
getLinkTags () | |
Returns the current <link> tags. | |
getMetaTags () | |
Returns the current <meta> tags. | |
getModules ( $filter=false, $position=null, $param='mModules', $type=RL\Module::TYPE_COMBINED) | |
Get the list of modules to include on this page. | |
getModuleStyles ( $filter=false, $position=null) | |
Get the list of style-only modules to load on this page. | |
getPageTitle () | |
Return the "page title", i.e. | |
getPreventClickjacking () | |
Get the prevent-clickjacking flag. | |
getProperty ( $name) | |
Get an additional output property. | |
getRedirect () | |
Get the URL to redirect to, or an empty string if not redirect URL set. | |
getResourceLoader () | |
Get a ResourceLoader object associated with this OutputPage. | |
getRevisionId () | |
Get the displayed revision ID. | |
getRevisionTimestamp () | |
Get the timestamp of displayed revision. | |
getRlClient () | |
Call this to freeze the module queue and JS config and create a formatter. | |
getRobotPolicy () | |
Get the current robot policy for the page as a string in the form <index policy>,<follow policy>. | |
getSections () | |
getSubtitle () | |
getSyndicationLinks () | |
Return URLs for each supported syndication format for this page. | |
getTarget () | |
getTemplateIds () | |
Get the templates used on this page. | |
getUnprefixedDisplayTitle () | |
Returns page display title without namespace prefix if possible. | |
getVaryHeader () | |
Return a Vary: header on which to vary caches. | |
hasHeadItem ( $name) | |
Check if the header item $name is already set. | |
haveCacheVaryCookies () | |
Check if the request has a cache-varying cookie header If it does, it's very important that we don't allow public caching. | |
headElement (Skin $sk, $includeStyle=true) | |
isArticle () | |
Return whether the content displayed page is related to the source of the corresponding article on the wiki. | |
isArticleRelated () | |
Return whether this page is related an article on the wiki. | |
isDisabled () | |
Return whether the output will be completely disabled. | |
isPrintable () | |
Return whether the page is "printable". | |
isRevisionCurrent () | |
Whether the revision displayed is the latest revision of the page. | |
isSyndicated () | |
Should we output feed links for this page? | |
isTOCEnabled () | |
Whether the output has a table of contents. | |
loadSkinModules ( $sk) | |
Transfer styles and JavaScript modules from skin. | |
lowerCdnMaxage ( $maxage) | |
Set the value of the "s-maxage" part of the "Cache-control" HTTP header to $maxage if that is lower than the current s-maxage. | |
makeResourceLoaderLink ( $modules, $only, array $extraQuery=[]) | |
Explicitly load or embed modules on a page. | |
output ( $return=false) | |
Finally, all the text has been munged and accumulated into the object, let's actually output it: | |
parseAsContent ( $text, $linestart=true) | |
Parse wikitext in the page content language and return the HTML. | |
parseAsInterface ( $text, $linestart=true) | |
Parse wikitext in the user interface language and return the HTML. | |
parseInlineAsInterface ( $text, $linestart=true) | |
Parse wikitext in the user interface language, strip paragraph wrapper, and return the HTML. | |
parserOptions () | |
Get/set the ParserOptions object to use for wikitext parsing. | |
prepareErrorPage ( $pageTitle, $htmlTitle=false) | |
Prepare this object to display an error page; disable caching and indexing, clear the current text and redirect, set the page's title and optionally an custom HTML title (content of the "<title>" tag). | |
prependHTML ( $text) | |
Prepend $text to the body HTML. | |
preventClickjacking ( $enable=true) | |
Set a flag which will cause an X-Frame-Options header appropriate for edit pages to be sent. | |
redirect ( $url, $responsecode='302') | |
Redirect to $url rather than displaying the normal page. | |
reduceAllowedModules ( $type, $level) | |
Limit the highest level of CSS/JS untrustworthiness allowed. | |
returnToMain ( $unused=null, $returnto=null, $returntoquery=null) | |
Add a "return to" link pointing to a specified title, or the title indicated in the request, or else the main page. | |
sendCacheControl () | |
Send cache control HTTP headers. | |
setArticleBodyOnly ( $only) | |
Set whether the output should only contain the body of the article, without any skin, sidebar, etc. | |
setArticleFlag ( $newVal) | |
Set whether the displayed content is related to the source of the corresponding article on the wiki Setting true will cause the change "article related" toggle to true. | |
setArticleRelated ( $newVal) | |
Set whether this page is related an article on the wiki Setting false will cause the change of "article flag" toggle to false. | |
setCanonicalUrl ( $url) | |
Set the URL to be used for the <link rel=canonical>>. | |
setCategoryLinks (array $categories) | |
Reset the category links (but not the category list) and add $categories. | |
setCdnMaxage ( $maxage) | |
Set the value of the "s-maxage" part of the "Cache-control" HTTP header. | |
setCopyright ( $hasCopyright) | |
Set whether the standard copyright should be shown for the current page. | |
setCopyrightUrl ( $url) | |
Set the copyright URL to send with the output. | |
setDisplayTitle ( $html) | |
Same as page title but only contains name of the page, not any other text. | |
setFeedAppendQuery ( $val) | |
Add default feeds to the page header This is mainly kept for backward compatibility, see OutputPage::addFeedLink() for the new version. | |
setFileVersion ( $file) | |
Set the displayed file version. | |
setFollowPolicy ( $policy) | |
Set the follow policy for the page, but leave the index policy un- touched. | |
setHTMLTitle ( $name) | |
"HTML title" means the contents of "<title>". | |
setIndexPolicy ( $policy) | |
Set the index policy for the page, but leave the follow policy un- touched. | |
setIndicators (array $indicators) | |
Add an array of indicators, with their identifiers as array keys and HTML contents as values. | |
setLanguageLinks (array $newLinkArray) | |
Reset the language links and add new language links. | |
setLastModified ( $timestamp) | |
Override the last modified timestamp. | |
setPageTitle ( $name) | |
"Page title" means the contents of \<h1\>. | |
setPreventClickjacking (bool $enable) | |
Set the prevent-clickjacking flag. | |
setPrintable () | |
Set the page as printable, i.e. | |
setProperty ( $name, $value) | |
Set an additional output property. | |
setRedirectedFrom (PageReference $t) | |
Set $mRedirectedFrom, the page which redirected us to the current page. | |
setRevisionId ( $revid) | |
Set the revision ID which will be seen by the wiki text parser for things such as embedded {{REVISIONID}} variable use. | |
setRevisionIsCurrent (bool $isCurrent) | |
Set whether the revision displayed (as set in ::setRevisionId()) is the latest revision of the page. | |
setRevisionTimestamp ( $timestamp) | |
Set the timestamp of the revision which will be displayed. | |
setRobotPolicy ( $policy) | |
Set the robot policy for the page: http://www.robotstxt.org/meta.html | |
setRobotsOptions (array $options=[]) | |
Set the robots policy with options for the page. | |
setSections (array $sections) | |
Adds sections to OutputPage from ParserOutput. | |
setStatusCode ( $statusCode) | |
Set the HTTP status code to send with the output. | |
setSubtitle ( $str) | |
Replace the subtitle with $str. | |
setSyndicated ( $show=true) | |
Add or remove feed links in the page header This is mainly kept for backward compatibility, see OutputPage::addFeedLink() for the new version. | |
setTarget ( $target) | |
Sets ResourceLoader target for load.php links. | |
setTitle (PageReference $t) | |
Set the Title object to use. | |
showErrorPage ( $title, $msg, $params=[], $returnto=null, $returntoquery=null) | |
Output a standard error page. | |
showFatalError ( $message) | |
Output an error page. | |
showLagWarning ( $lag) | |
Show a warning about replica DB lag. | |
showNewSectionLink () | |
Show an "add new section" link? | |
showPermissionsErrorPage (array $errors, $action=null) | |
Output a standard permission error page. | |
showsCopyright () | |
Return whether the standard copyright should be shown for the current page. | |
tailElement ( $skin) | |
The final bits that go to the bottom of a page HTML document including the closing tags. | |
userCanPreview () | |
To make it harder for someone to slip a user a fake JavaScript or CSS preview, a random token is associated with the login session. | |
versionRequired ( $version) | |
Display an error page indicating that a given version of MediaWiki is required to use it. | |
wrapWikiMsg ( $wrap,... $msgSpecs) | |
This function takes a number of message/argument specifications, wraps them in some overall structure, and then parses the result and adds it to the output. | |
wrapWikiTextAsInterface ( $wrapperClass, $text) | |
Convert wikitext in the user interface language to HTML and add it to the buffer with a <div class="$wrapperClass"> wrapper. | |
Public Member Functions inherited from ContextSource | |
canUseWikiPage () | |
Check whether a WikiPage object can be get with getWikiPage(). | |
exportSession () | |
Export the resolved user IP, HTTP headers, user ID, and session ID. | |
getActionName () | |
Get the action name for the current web request. | |
getAuthority () | |
getConfig () | |
getContext () | |
Get the base IContextSource object. | |
getCsrfTokenSet () | |
Get a repository to obtain and match CSRF tokens. | |
getLanguage () | |
getOutput () | |
getRequest () | |
getSkin () | |
getStats () | |
getTiming () | |
getTitle () | |
getUser () | |
getWikiPage () | |
Get the WikiPage object. | |
msg ( $key,... $params) | |
Get a Message object with context set Parameters are the same as wfMessage() | |
setContext (IContextSource $context) | |
Static Public Member Functions | |
static | buildBacklinkSubtitle (PageReference $page, $query=[]) |
Build message object for a subtitle containing a backlink to a page. | |
static | setupOOUI ( $skinName='default', $dir='ltr') |
Helper function to setup the PHP implementation of OOUI to use in this request. | |
static | transformCssMedia ( $media) |
Transform "media" attribute based on request parameters. | |
static | transformFilePath ( $remotePathPrefix, $localPath, $file) |
Utility method for transformResourceFilePath(). | |
static | transformResourcePath (Config $config, $path) |
Transform path to web-accessible static resource. | |
Public Attributes | |
string | $mBodytext = '' |
Contains all of the "<body>" content. | |
bool | $mNoGallery = false |
Comes from the parser. | |
string | $mPageLinkTitle = '' |
Used by skin template. | |
string | $mRedirect = '' |
string | $mRedirectCode = '' |
Protected Member Functions | |
addCategoryLinksToLBAndGetResult (array $categories) | |
buildExemptModules () | |
Build exempt modules and legacy non-ResourceLoader styles. | |
filterModules (array $modules, $position=null, $type=RL\Module::TYPE_COMBINED) | |
Filter an array of modules to remove insufficiently trustworthy members, and modules which are no longer registered (eg a page is cached before an extension is disabled) | |
getAdvertisedFeedTypes () | |
Return effective list of advertised feed types. | |
styleLink ( $style, array $options) | |
Generate \<link\> tags for stylesheets. | |
Static Protected Member Functions | |
static | combineWrappedStrings (array $chunks) |
Combine WrappedString chunks and filter out empty ones. | |
Protected Attributes | |
array | $mAdditionalBodyClasses = [] |
Additional <body> classes; there are also <body> classes from other sources. | |
array | $mAdditionalHtmlClasses = [] |
Additional <html> classes; This should be rarely modified; prefer mAdditionalBodyClasses. | |
array | $mAllowedModules |
What level of 'untrustworthiness' is allowed in CSS/JS modules loaded on this page? | |
string bool | $mCanonicalUrl = false |
string[][] | $mCategories |
string[][] | $mCategoryLinks = [] |
int | $mCdnMaxage = 0 |
Cache stuff. | |
int | $mCdnMaxageLimit = INF |
Upper limit on mCdnMaxage. | |
bool | $mDoNothing = false |
Whether output is disabled. | |
bool | $mEnableClientCache = true |
Set to false to send no-cache headers, disabling client-side caching. | |
$mFeedLinksAppendQuery = null | |
array | $mFileVersion = null |
array | $mHeadItems = [] |
Array of elements in "<head>". | |
bool | $mHideNewSectionLink = false |
array | $mImageTimeKeys = [] |
string[] | $mIndicators = [] |
string | $mInlineStyles = '' |
Inline CSS styles. | |
array | $mJsConfigVars = [] |
string | $mLastModified = '' |
Used for sending cache control. | |
array | $mLinktags = [] |
string[][] | $mMetatags = [] |
Should be private. | |
array | $mModules = [] |
array | $mModuleStyles = [] |
bool | $mNewSectionLink = false |
ParserOptions | $mParserOptions = null |
lazy initialised, use parserOptions() | |
bool | $mPreventClickjacking = true |
Controls if anti-clickjacking / frame-breaking headers will be sent. | |
ResourceLoader | $mResourceLoader |
int | $mStatusCode |
array | $mTemplateIds = [] |
array | $styles = [] |
An array of stylesheet filenames (relative from skins path), with options for CSS media, IE conditions, and RTL/LTR direction. | |
This is one of the Core classes and should be read at least once by any new developers.
Also documented at https://www.mediawiki.org/wiki/Manual:Architectural_modules/OutputPage
This class is used to prepare the final rendering. A skin is then applied to the output parameters (links, javascript, html, categories ...).
Some comments comes from a pairing session between Zak Greant and Antoine Musso in November 2010.
Definition at line 54 of file OutputPage.php.
OutputPage::__construct | ( | IContextSource | $context | ) |
Constructor for OutputPage.
This should not be called directly. Instead a new RequestContext should be created and it will implicitly create a OutputPage tied to that context.
IContextSource | $context |
Definition at line 400 of file OutputPage.php.
References IContextSource\getConfig(), IContextSource\getRequest(), and ContextSource\setContext().
OutputPage::adaptCdnTTL | ( | $mtime, | |
$minTTL = 0, | |||
$maxTTL = 0 ) |
Get TTL in [$minTTL,$maxTTL] and pass it to lowerCdnMaxage()
This sets and returns $minTTL if $mtime is false or null. Otherwise, the TTL is higher the older the $mtime timestamp is. Essentially, the TTL is 90% of the age of the object, subject to the min and max.
string | int | float | bool | null | $mtime | Last-Modified timestamp |
int | $minTTL | Minimum TTL in seconds [default: 1 minute] |
int | $maxTTL | Maximum TTL in seconds [default: $wgCdnMaxAge] |
Definition at line 2373 of file OutputPage.php.
References wfTimestamp().
OutputPage::addBacklinkSubtitle | ( | PageReference | $title, |
$query = [] ) |
Add a subtitle containing a backlink to a page.
PageReference | $title | Title to link to |
array | $query | Array of additional parameters to include in the link |
Definition at line 1239 of file OutputPage.php.
References $title.
OutputPage::addBodyClasses | ( | $classes | ) |
Add a class to the <body> element.
string | string[] | $classes | One or more classes to add |
Definition at line 751 of file OutputPage.php.
OutputPage::addCategoryLinks | ( | array | $categories | ) |
Add an array of categories, with names in the keys.
array | $categories | Mapping category name => sort key |
Definition at line 1498 of file OutputPage.php.
References $res, $title, $type, and NS_CATEGORY.
|
protected |
array | $categories |
Definition at line 1556 of file OutputPage.php.
References $dbr, $res, DB_REPLICA, NS_CATEGORY, and wfGetDB().
OutputPage::addContentOverride | ( | $target, | |
Content | $content ) |
Force the given Content object for the given page, for things like page preview.
LinkTarget | PageReference | $target | |
Content | $content |
Definition at line 665 of file OutputPage.php.
References $content, and addContentOverrideCallback().
OutputPage::addContentOverrideCallback | ( | callable | $callback | ) |
Add a callback for mapping from a Title to a Content object, for things like page preview.
callable | $callback |
Definition at line 685 of file OutputPage.php.
Referenced by addContentOverride().
OutputPage::addElement | ( | $element, | |
array | $attribs = [], | ||
$contents = '' ) |
Shortcut for adding an Html::element via addHTML.
string | $element | |
array | $attribs | |
string | $contents |
Definition at line 1790 of file OutputPage.php.
OutputPage::addFeedLink | ( | $format, | |
$href ) |
Add a feed link to the page header.
string | $format | Feed type, should be a key of $wgFeedClasses |
string | $href | URL |
Definition at line 1365 of file OutputPage.php.
OutputPage::addHeadItem | ( | $name, | |
$value ) |
Add or replace a head item to the output.
Whenever possible, use more specific options like ResourceLoader modules, OutputPage::addLink(), OutputPage::addMeta() and OutputPage::addFeedLink() Fallback options for those are: OutputPage::addStyle, OutputPage::addScript(), OutputPage::addInlineScript() and OutputPage::addInlineStyle() This would be your very LAST fallback.
string | $name | Item name |
string | $value | Raw HTML |
Definition at line 721 of file OutputPage.php.
OutputPage::addHeadItems | ( | $values | ) |
Add one or more head items to the output.
string | string[] | $values | Raw HTML |
Definition at line 731 of file OutputPage.php.
OutputPage::addHelpLink | ( | $to, | |
$overrideBaseUrl = false ) |
Adds help link with an icon via page indicators.
Link target can be overridden by a local message containing a wikilink: the message key is: lowercase action or special page name + '-helppage'.
string | $to | Target MediaWiki.org page title or encoded URL. |
bool | $overrideBaseUrl | Whether $url is a full URL, to avoid MW.o. |
Definition at line 1682 of file OutputPage.php.
References wfUrlencode().
OutputPage::addHTML | ( | $text | ) |
Append $text to the body HTML.
string | $text | HTML |
Definition at line 1777 of file OutputPage.php.
Referenced by Article\doDelete(), and Article\showPatrolFooter().
OutputPage::addHtmlClasses | ( | $classes | ) |
Add a class to the <html> element.
This should rarely be used. Instead use OutputPage::addBodyClasses() if possible.
string | string[] | $classes | One or more classes to add |
Definition at line 696 of file OutputPage.php.
OutputPage::addInlineScript | ( | $script | ) |
Add a self-contained script tag with the given contents Internal use only.
Use OutputPage::addModules() if possible.
string | $script | JavaScript text, no script tags |
Definition at line 542 of file OutputPage.php.
OutputPage::addInlineStyle | ( | $style_css, | |
$flip = 'noflip' ) |
Adds inline CSS styles Internal use only.
Use OutputPage::addModuleStyles() if possible.
mixed | $style_css | Inline CSS |
string | $flip | Set to 'flip' to flip the CSS if needed |
Definition at line 4078 of file OutputPage.php.
OutputPage::addJsConfigVars | ( | $keys, | |
$value = null ) |
Add one or more variables to be set in mw.config in JavaScript.
string | array | $keys | Key or array of key/value pairs |
mixed | null | $value | [optional] Value of the configuration variable |
Definition at line 3522 of file OutputPage.php.
References $keys.
Referenced by Article\showRedirectedFromHeader().
OutputPage::addLanguageLinks | ( | array | $newLinkArray | ) |
Add new language links.
string[] | $newLinkArray | Array of interwiki-prefixed (non DB key) titles (e.g. 'fr:Test page') |
Definition at line 1470 of file OutputPage.php.
OutputPage::addLink | ( | array | $linkarr | ) |
Add a new \<link\> tag to the page header.
Note: use setCanonicalUrl() for rel=canonical.
array | $linkarr | Associative array of attributes. |
Definition at line 479 of file OutputPage.php.
OutputPage::addLinkHeader | ( | $header | ) |
Add an HTTP Link: header.
string | $header | Header value |
Definition at line 2524 of file OutputPage.php.
References $header.
OutputPage::addMeta | ( | $name, | |
$val ) |
Add a new "<meta>" tag To add an http-equiv meta tag, precede the name with "http:".
string | $name | Name of the meta tag |
string | $val | Value of the meta tag |
Definition at line 458 of file OutputPage.php.
Referenced by Skin\initPage().
OutputPage::addModules | ( | $modules | ) |
Load one or more ResourceLoader modules on this page.
string | array | $modules | Module name (string) or array of module names |
Definition at line 612 of file OutputPage.php.
References $modules.
Referenced by ListToggle\__construct(), MWDebug\addModules(), Article\showPatrolFooter(), and Article\showRedirectedFromHeader().
OutputPage::addModuleStyles | ( | $modules | ) |
Load the styles of one or more style-only ResourceLoader modules on this page.
Module styles added through this function will be loaded as a stylesheet, using a standard <link rel=stylesheet>
HTML tag, rather than as a combined Javascript and CSS package. Thus, they will even load when JavaScript is disabled.
string | array | $modules | Module name (string) or array of module names |
Definition at line 638 of file OutputPage.php.
References $modules.
Referenced by ListToggle\__construct(), Article\setOldSubtitle(), and Article\showPatrolFooter().
OutputPage::addParserOutput | ( | ParserOutput | $parserOutput, |
$poOptions = [] ) |
Add everything from a ParserOutput object.
ParserOutput | $parserOutput | |
array | $poOptions | Options to ParserOutput::getText() |
Definition at line 2231 of file OutputPage.php.
OutputPage::addParserOutputContent | ( | ParserOutput | $parserOutput, |
$poOptions = [] ) |
Add the HTML and enhancements for it (like ResourceLoader modules) associated with a ParserOutput object, without any other metadata.
ParserOutput | $parserOutput | |
array | $poOptions | Options to ParserOutput::getText() |
Definition at line 2203 of file OutputPage.php.
References ParserOutput\getJsConfigVars(), ParserOutput\getModules(), and ParserOutput\getModuleStyles().
OutputPage::addParserOutputMetadata | ( | ParserOutput | $parserOutput | ) |
Add all metadata associated with a ParserOutput object, but without the actual HTML.
This includes categories, language links, ResourceLoader modules, effects of certain magic words, and so on. It does not include section information.
ParserOutput | $parserOutput |
Definition at line 2071 of file OutputPage.php.
References ParserOutput\getCategories(), ParserOutput\getEnableOOUI(), ParserOutput\getExtraCSPDefaultSrcs(), ParserOutput\getExtraCSPScriptSrcs(), ParserOutput\getExtraCSPStyleSrcs(), ParserOutput\getFileSearchOptions(), ParserOutput\getHeadItems(), ParserOutput\getHideNewSection(), ParserOutput\getImages(), ParserOutput\getIndicators(), ParserOutput\getJsConfigVars(), ParserOutput\getLanguageLinks(), ParserOutput\getLimitReportJSData(), ParserOutput\getModules(), ParserOutput\getModuleStyles(), ParserOutput\getNewSection(), ParserOutput\getNoGallery(), ParserOutput\getOutputHooks(), ParserOutput\getPreventClickjacking(), ParserOutput\getTemplateIds(), getTitle(), ParserOutput\getTOCHTML(), ParserOutput\getWrapperDivClass(), and CacheTime\isCacheable().
OutputPage::addParserOutputText | ( | ParserOutput | $parserOutput, |
$poOptions = [] ) |
Add the HTML associated with a ParserOutput object, without any metadata.
ParserOutput | $parserOutput | |
array | $poOptions | Options to ParserOutput::getText() |
Definition at line 2219 of file OutputPage.php.
References ParserOutput\getText().
OutputPage::addReturnTo | ( | $title, | |
array | $query = [], | ||
$text = null, | |||
$options = [] ) |
Add a "return to" link pointing to a specified title.
LinkTarget | $title | Title to link |
array | $query | Query string parameters |
string | null | $text | Text of the link (input is not escaped) |
array | $options | Options array to pass to Linker |
Definition at line 3155 of file OutputPage.php.
References $title.
OutputPage::addScript | ( | $script | ) |
Add raw HTML to the list of scripts (including \<script\> tag, etc.) Internal use only.
Use OutputPage::addModules() or OutputPage::addJsConfigVars() if possible.
string | $script | Raw HTML |
Definition at line 520 of file OutputPage.php.
Referenced by addScriptFile().
OutputPage::addScriptFile | ( | $file, | |
$unused = null ) |
Add a JavaScript file to be loaded as <script>
on this page.
Internal use only. Use OutputPage::addModules() if possible.
string | $file | URL to file (absolute path, protocol-relative, or full url) |
string | null | $unused | Previously used to change the cache-busting query parameter |
Definition at line 532 of file OutputPage.php.
References $file, and addScript().
OutputPage::addStyle | ( | $style, | |
$media = '', | |||
$condition = '', | |||
$dir = '' ) |
Add a local or specified stylesheet, with the given media options.
Internal use only. Use OutputPage::addModuleStyles() if possible.
string | $style | URL to the file |
string | $media | To specify a media type, 'screen', 'printable', 'handheld' or any. |
string | $condition | For IE conditional comments, specifying an IE version |
string | $dir | Set to 'rtl' or 'ltr' for direction-specific sheets |
Definition at line 4057 of file OutputPage.php.
OutputPage::addSubtitle | ( | $str | ) |
Add $str to the subtitle.
string | Message | $str | String or Message to add to the subtitle. String should be safe HTML. |
Definition at line 1201 of file OutputPage.php.
References getContext().
Referenced by Article\setOldSubtitle(), and Article\showRedirectedFromHeader().
OutputPage::addTemplate | ( | & | $template | ) |
Add the output of a QuickTemplate to the output buffer.
QuickTemplate | &$template |
Definition at line 2241 of file OutputPage.php.
OutputPage::addVaryHeader | ( | $header, | |
array | $option = null ) |
Add an HTTP header that will influence on the cache.
string | $header | Header name |
string[] | null | $option | Deprecated; formerly options for the Key header, deprecated in 1.32 and removed in 1.34. See https://datatracker.ietf.org/doc/draft-fielding-http-key/ for the list of formerly-valid options. |
Definition at line 2490 of file OutputPage.php.
References $header, and wfDeprecatedMsg().
OutputPage::addWikiMsg | ( | $args | ) |
Add a wikitext-formatted message to the output.
This is equivalent to:
$wgOut->addWikiText( wfMessage( ... )->plain() )
mixed | ...$args |
Definition at line 4323 of file OutputPage.php.
References $args.
Referenced by Article\doDelete().
OutputPage::addWikiMsgArray | ( | $name, | |
$args ) |
Add a wikitext-formatted message to the output.
Like addWikiMsg() except the parameters are taken as an array instead of a variable argument list.
string | $name | |
array | $args |
Definition at line 4336 of file OutputPage.php.
References $args.
OutputPage::addWikiTextAsContent | ( | $text, | |
$linestart = true, | |||
PageReference | $title = null ) |
Convert wikitext in the page content language to HTML and add it to the buffer.
The result with be language-converted to the user's preferred variant. Assumes that the current page title will be used if optional $title is not provided. Output will be tidy.
string | $text | Wikitext in the page content language |
bool | $linestart | Is this the start of a line? (Defaults to true) |
PageReference | null | $title | Optional title to use; default of null means use current page title. |
MWException | if $title is not provided and OutputPage::getTitle() is null |
Definition at line 2008 of file OutputPage.php.
References $title, and getTitle().
Referenced by Article\showMissingArticle().
OutputPage::addWikiTextAsInterface | ( | $text, | |
$linestart = true, | |||
PageReference | $title = null ) |
Convert wikitext in the user interface language to HTML and add it to the buffer.
The result will not be language-converted, as user interface messages are already localized into a specific variant. Assumes that the current page title will be used if optional $title is not provided. Output will be tidy.
string | $text | Wikitext in the user interface language |
bool | $linestart | Is this the start of a line? (Defaults to true) |
PageReference | null | $title | Optional title to use; default of null means use current page title. |
MWException | if $title is not provided and OutputPage::getTitle() is null |
Definition at line 1958 of file OutputPage.php.
References $title, and getTitle().
Referenced by Article\showMissingArticle().
OutputPage::allowClickjacking | ( | ) |
Turn off frame-breaking.
Alias for $this->preventClickjacking(false). This can be called from pages which do not contain any CSRF-protected HTML form.
Definition at line 2583 of file OutputPage.php.
|
static |
Build message object for a subtitle containing a backlink to a page.
PageReference | $page | Title to link to |
array | $query | Array of additional parameters to include in the link |
Definition at line 1217 of file OutputPage.php.
References MediaWiki\Page\PageReference\getNamespace(), NS_SPECIAL, and wfMessage().
OutputPage::buildCssLinksArray | ( | ) |
|
protected |
Build exempt modules and legacy non-ResourceLoader styles.
Definition at line 4091 of file OutputPage.php.
OutputPage::checkLastModified | ( | $timestamp | ) |
checkLastModified tells the client to use the client-cached page if possible.
If successful, the OutputPage is disabled so that any future call to OutputPage->output() have no effect.
Side effect: sets mLastModified for Last-Modified header
string | $timestamp |
Definition at line 808 of file OutputPage.php.
References disable(), ContextSource\getConfig(), ContextSource\getRequest(), getUser(), sendCacheControl(), wfDebug(), wfResetOutputBuffers(), and wfTimestamp().
OutputPage::clearHTML | ( | ) |
Clear the body HTML.
Definition at line 1797 of file OutputPage.php.
OutputPage::clearSubtitle | ( | ) |
Clear the subtitles.
Definition at line 1246 of file OutputPage.php.
|
staticprotected |
Combine WrappedString chunks and filter out empty ones.
array | $chunks |
Definition at line 3467 of file OutputPage.php.
OutputPage::considerCacheSettingsFinal | ( | ) |
Set the expectation that cache control will not change after this point.
This should be called after the main processing logic has completed (e.g. Action::show or SpecialPage::execute), but may be called before Skin output has started (OutputPage::output).
Definition at line 2439 of file OutputPage.php.
OutputPage::couldBePublicCached | ( | ) |
Whether the output might become publicly cached.
Definition at line 2416 of file OutputPage.php.
OutputPage::disable | ( | ) |
Disable output completely, i.e.
calling output() will have no effect
Definition at line 1277 of file OutputPage.php.
Referenced by checkLastModified().
OutputPage::disableClientCache | ( | ) |
Force the page to send nocache headers.
Definition at line 2406 of file OutputPage.php.
Referenced by SkinFallback\initPage().
OutputPage::disallowUserJs | ( | ) |
Do not allow scripts which can be modified by wiki users to load on this page; only allow scripts bundled with, or generated by, the software.
Site-wide styles are controlled by a config setting, since they can be used to create a custom skin/theme, but not user-specific ones.
Definition at line 1717 of file OutputPage.php.
OutputPage::enableClientCache | ( | $state | ) |
Use enableClientCache(false) to force it to send nocache headers.
bool | null | $state | New value, or null to not set the value |
false
when this method is called) Definition at line 2397 of file OutputPage.php.
References wfDeprecated(), and wfSetVar().
OutputPage::enableOOUI | ( | ) |
Add ResourceLoader module styles for OOUI and set up the PHP implementation of it for use with MediaWiki and this OutputPage instance.
Definition at line 4412 of file OutputPage.php.
|
protected |
Filter an array of modules to remove insufficiently trustworthy members, and modules which are no longer registered (eg a page is cached before an extension is disabled)
string[] | $modules | |
string | null | $position | Unused |
string | $type |
Definition at line 554 of file OutputPage.php.
References $modules, $type, and getResourceLoader().
Referenced by getModules().
OutputPage::forceHideNewSectionLink | ( | ) |
OutputPage::formatPermissionsErrorMessage | ( | array | $errors, |
$action = null ) |
Format a list of error messages.
array | $errors | Array of arrays returned by PermissionManager::getPermissionErrors |
string | null | $action | Action that was denied or null if unknown |
Definition at line 3082 of file OutputPage.php.
OutputPage::formatPermissionStatus | ( | PermissionStatus | $status, |
string | $action = null ) |
Format permission $status obtained from Authority for display.
PermissionStatus | $status | |
string | null | $action | that was denied or null if unknown |
Definition at line 3066 of file OutputPage.php.
|
protected |
Return effective list of advertised feed types.
Definition at line 1330 of file OutputPage.php.
OutputPage::getAllowedModules | ( | $type | ) |
Show what level of JavaScript / CSS untrustworthiness is allowed on this page.
string | $type | RL\Module TYPE_ constant |
Definition at line 1742 of file OutputPage.php.
References $type.
OutputPage::getArticleBodyOnly | ( | ) |
Return whether the output will contain only the body of the article.
Definition at line 771 of file OutputPage.php.
OutputPage::getBottomScripts | ( | ) |
JS stuff to put at the bottom of the <body>
.
These are legacy scripts ($this->mScripts), and user JS.
Definition at line 3479 of file OutputPage.php.
OutputPage::getCacheVaryCookies | ( | ) |
Get the list of cookie names that will influence the cache.
Definition at line 2448 of file OutputPage.php.
OutputPage::getCanonicalUrl | ( | ) |
Returns the URL to be used for the <link rel=canonical>> if one is set.
Definition at line 509 of file OutputPage.php.
OutputPage::getCategories | ( | $type = 'all' | ) |
Get the list of category names this page belongs to.
string | $type | The type of categories which should be returned. Possible values:
|
Definition at line 1620 of file OutputPage.php.
References $type.
OutputPage::getCategoryLinks | ( | ) |
Get the list of category links, in a 2-D array with the following format: $arr[$type][] = $link, where $type is either "normal" or "hidden" (for hidden categories) and $link a HTML fragment with a link to the category page.
Definition at line 1607 of file OutputPage.php.
OutputPage::getCSP | ( | ) |
Get the ContentSecurityPolicy object.
Definition at line 4445 of file OutputPage.php.
OutputPage::getCSPNonce | ( | ) |
Get (and set if not yet set) the CSP nonce.
This value needs to be included in any <script> tags on the page.
Definition at line 4435 of file OutputPage.php.
OutputPage::getDisplayTitle | ( | ) |
Returns page display title.
Performs some normalization, but this not as strict the magic word.
Definition at line 1129 of file OutputPage.php.
References getTitle().
OutputPage::getFeedAppendQuery | ( | ) |
OutputPage::getFileSearchOptions | ( | ) |
Get the files used on this page.
Definition at line 1938 of file OutputPage.php.
OutputPage::getFileVersion | ( | ) |
Get the displayed file version.
Definition at line 1918 of file OutputPage.php.
OutputPage::getFollowPolicy | ( | ) |
Get the current follow policy for the page as a string.
Definition at line 1036 of file OutputPage.php.
OutputPage::getFrameOptions | ( | ) |
Get the X-Frame-Options header value (without the name part), or false if there isn't one.
This is used by Skin to determine whether to enable JavaScript frame-breaking, for clients that don't support X-Frame-Options.
Definition at line 2626 of file OutputPage.php.
OutputPage::getHeadItemsArray | ( | ) |
OutputPage::getHeadLinksArray | ( | ) |
Definition at line 3758 of file OutputPage.php.
References $lang, $type, getAuthority(), getContext(), getTitle(), SpecialPage\getTitleFor(), MW_VERSION, PROTO_CANONICAL, PROTO_RELATIVE, wfAppendQuery(), wfExpandUrl(), and wfScript().
OutputPage::getHTML | ( | ) |
OutputPage::getHTMLTitle | ( | ) |
Return the "HTML title", i.e.
the content of the "<title>" tag.
Definition at line 1059 of file OutputPage.php.
Referenced by Skin\initPage().
OutputPage::getIndexPolicy | ( | ) |
Get the current index policy for the page as a string.
Definition at line 1014 of file OutputPage.php.
OutputPage::getIndicators | ( | ) |
Get the indicators associated with this page.
The array will be internally ordered by item keys.
Definition at line 1661 of file OutputPage.php.
OutputPage::getJsConfigVars | ( | ) |
Get the javascript config vars to include on this page.
Definition at line 3512 of file OutputPage.php.
OutputPage::getJSVars | ( | ) |
Get an array containing the variables to be set in mw.config in JavaScript.
Do not add things here which can be evaluated in RL\StartUpModule
Definition at line 3542 of file OutputPage.php.
References $lang, $title, $type, getAuthority(), getContext(), getTitle(), getUser(), NS_SPECIAL, and wfTimestamp().
OutputPage::getLanguageLinks | ( | ) |
Get the list of language links.
Definition at line 1489 of file OutputPage.php.
OutputPage::getLinkHeader | ( | ) |
Return a Link: header.
Based on the values of $mLinkHeader.
Definition at line 2533 of file OutputPage.php.
OutputPage::getLinkTags | ( | ) |
Returns the current <link> tags.
Definition at line 489 of file OutputPage.php.
OutputPage::getMetaTags | ( | ) |
Returns the current <meta> tags.
Definition at line 468 of file OutputPage.php.
OutputPage::getModules | ( | $filter = false, | |
$position = null, | |||
$param = 'mModules', | |||
$type = RL\Module::TYPE_COMBINED ) |
Get the list of modules to include on this page.
bool | $filter | Whether to filter out insufficiently trustworthy modules |
string | null | $position | Unused |
string | $param | |
string | $type |
Definition at line 598 of file OutputPage.php.
References $modules, $type, and filterModules().
Referenced by getModuleStyles().
OutputPage::getModuleStyles | ( | $filter = false, | |
$position = null ) |
Get the list of style-only modules to load on this page.
bool | $filter | |
string | null | $position | Unused |
Definition at line 623 of file OutputPage.php.
References getModules().
OutputPage::getPageTitle | ( | ) |
Return the "page title", i.e.
the content of the \<h1\> tag.
Definition at line 1106 of file OutputPage.php.
OutputPage::getPreventClickjacking | ( | ) |
Get the prevent-clickjacking flag.
Definition at line 2615 of file OutputPage.php.
OutputPage::getProperty | ( | $name | ) |
Get an additional output property.
string | $name |
Definition at line 793 of file OutputPage.php.
OutputPage::getRedirect | ( | ) |
Get the URL to redirect to, or an empty string if not redirect URL set.
Definition at line 426 of file OutputPage.php.
OutputPage::getResourceLoader | ( | ) |
Get a ResourceLoader object associated with this OutputPage.
Definition at line 3432 of file OutputPage.php.
Referenced by filterModules().
OutputPage::getRevisionId | ( | ) |
OutputPage::getRevisionTimestamp | ( | ) |
Get the timestamp of displayed revision.
This will be null if not filled by setRevisionTimestamp().
Definition at line 1895 of file OutputPage.php.
OutputPage::getRlClient | ( | ) |
Call this to freeze the module queue and JS config and create a formatter.
Depending on the Skin, this may get lazy-initialised in either headElement() or getBottomScripts(). See SkinTemplate::prepareQuickTemplate(). Calling this too early may cause unexpected side-effects since disallowUserJs() may be called at any time to change the module filters retroactively. Skins and extension hooks may also add modules until very late in the request lifecycle.
Definition at line 3253 of file OutputPage.php.
References $dbr, DB_REPLICA, MediaWiki\ResourceLoader\ClientHtml\setConfig(), and wfGetDB().
OutputPage::getRobotPolicy | ( | ) |
Get the current robot policy for the page as a string in the form <index policy>,<follow policy>.
Definition at line 940 of file OutputPage.php.
OutputPage::getSections | ( | ) |
Definition at line 2059 of file OutputPage.php.
OutputPage::getSubtitle | ( | ) |
Definition at line 1253 of file OutputPage.php.
OutputPage::getSyndicationLinks | ( | ) |
Return URLs for each supported syndication format for this page.
Definition at line 1383 of file OutputPage.php.
OutputPage::getTarget | ( | ) |
Definition at line 645 of file OutputPage.php.
OutputPage::getTemplateIds | ( | ) |
Get the templates used on this page.
Definition at line 1928 of file OutputPage.php.
OutputPage::getUnprefixedDisplayTitle | ( | ) |
Returns page display title without namespace prefix if possible.
This method is unreliable and best avoided. (T314399)
Definition at line 1146 of file OutputPage.php.
References $matches, Parser\formatPageTitle(), and getTitle().
OutputPage::getVaryHeader | ( | ) |
Return a Vary: header on which to vary caches.
Based on the keys of $mVaryHeader, such as Accept-Encoding or Cookie
Definition at line 2507 of file OutputPage.php.
References $header.
OutputPage::hasHeadItem | ( | $name | ) |
Check if the header item $name is already set.
string | $name | Item name |
Definition at line 741 of file OutputPage.php.
OutputPage::haveCacheVaryCookies | ( | ) |
Check if the request has a cache-varying cookie header If it does, it's very important that we don't allow public caching.
Definition at line 2469 of file OutputPage.php.
References wfDebug().
Definition at line 3338 of file OutputPage.php.
References getContext(), Skin\getHtmlElementAttributes(), Skin\getOptions(), Skin\getPageClasses(), Skin\getSkinName(), getTitle(), getUser(), Skin\isResponsive(), and wfDeprecated().
OutputPage::isArticle | ( | ) |
Return whether the content displayed page is related to the source of the corresponding article on the wiki.
Definition at line 1416 of file OutputPage.php.
OutputPage::isArticleRelated | ( | ) |
Return whether this page is related an article on the wiki.
Definition at line 1438 of file OutputPage.php.
OutputPage::isDisabled | ( | ) |
Return whether the output will be completely disabled.
Definition at line 1286 of file OutputPage.php.
OutputPage::isPrintable | ( | ) |
OutputPage::isRevisionCurrent | ( | ) |
Whether the revision displayed is the latest revision of the page.
Definition at line 1870 of file OutputPage.php.
OutputPage::isSyndicated | ( | ) |
Should we output feed links for this page?
Definition at line 1375 of file OutputPage.php.
OutputPage::isTOCEnabled | ( | ) |
Whether the output has a table of contents.
Definition at line 4386 of file OutputPage.php.
OutputPage::loadSkinModules | ( | $sk | ) |
Transfer styles and JavaScript modules from skin.
Skin | $sk | to load modules for |
Definition at line 2750 of file OutputPage.php.
References $modules.
OutputPage::lowerCdnMaxage | ( | $maxage | ) |
Set the value of the "s-maxage" part of the "Cache-control" HTTP header to $maxage if that is lower than the current s-maxage.
Either way, $maxage is now an upper limit on s-maxage, so that future calls to setCdnMaxage() will no longer be able to raise the s-maxage above $maxage.
int | $maxage | Maximum cache time on the CDN, in seconds |
Definition at line 2356 of file OutputPage.php.
OutputPage::makeResourceLoaderLink | ( | $modules, | |
$only, | |||
array | $extraQuery = [] ) |
Explicitly load or embed modules on a page.
array | string | $modules | One or more module names |
string | $only | RL\Module TYPE_ class constant |
array | $extraQuery | [optional] Array with extra query parameters for the request |
Definition at line 3448 of file OutputPage.php.
References $modules.
OutputPage::output | ( | $return = false | ) |
Finally, all the text has been munged and accumulated into the object, let's actually output it:
bool | $return | Set to true to get the result as a string rather than sending it |
Exception | |
FatalError | |
MWException |
Definition at line 2772 of file OutputPage.php.
References $content, print, PROTO_CURRENT, wfExpandUrl(), and wfTimestamp().
OutputPage::parseAsContent | ( | $text, | |
$linestart = true ) |
Parse wikitext in the page content language and return the HTML.
The result will be language-converted to the user's preferred variant. Output will be tidy.
string | $text | Wikitext in the page content language |
bool | $linestart | Is this the start of a line? (Defaults to true) |
MWException |
Definition at line 2256 of file OutputPage.php.
References getTitle().
OutputPage::parseAsInterface | ( | $text, | |
$linestart = true ) |
Parse wikitext in the user interface language and return the HTML.
The result will not be language-converted, as user interface messages are already localized into a specific variant. Output will be tidy.
string | $text | Wikitext in the user interface language |
bool | $linestart | Is this the start of a line? (Defaults to true) |
MWException |
Definition at line 2277 of file OutputPage.php.
References getTitle().
OutputPage::parseInlineAsInterface | ( | $text, | |
$linestart = true ) |
Parse wikitext in the user interface language, strip paragraph wrapper, and return the HTML.
The result will not be language-converted, as user interface messages are already localized into a specific variant. Output will be tidy. Outer paragraph wrapper will only be stripped if the result is a single paragraph.
string | $text | Wikitext in the user interface language |
bool | $linestart | Is this the start of a line? (Defaults to true) |
MWException |
Definition at line 2300 of file OutputPage.php.
References Parser\stripOuterParagraph().
OutputPage::parserOptions | ( | ) |
Get/set the ParserOptions object to use for wikitext parsing.
Definition at line 1815 of file OutputPage.php.
References getContext(), and getUser().
OutputPage::prepareErrorPage | ( | $pageTitle, | |
$htmlTitle = false ) |
Prepare this object to display an error page; disable caching and indexing, clear the current text and redirect, set the page's title and optionally an custom HTML title (content of the "<title>" tag).
string | Message | $pageTitle | Will be passed directly to setPageTitle() |
string | Message | false | $htmlTitle | Will be passed directly to setHTMLTitle(); optional, if not passed the "<title>" attribute will be based on $pageTitle |
Definition at line 2911 of file OutputPage.php.
OutputPage::prependHTML | ( | $text | ) |
Prepend $text to the body HTML.
string | $text | HTML |
Definition at line 1768 of file OutputPage.php.
OutputPage::preventClickjacking | ( | $enable = true | ) |
Set a flag which will cause an X-Frame-Options header appropriate for edit pages to be sent.
The header value is controlled by $wgEditPageFrameOptions.
This is the default for special pages. If you display a CSRF-protected form on an ordinary view page, then you need to call this function.
bool | $enable |
Definition at line 2572 of file OutputPage.php.
OutputPage::redirect | ( | $url, | |
$responsecode = '302' ) |
Redirect to $url rather than displaying the normal page.
string | $url | |
string | int | $responsecode | HTTP status code |
Definition at line 415 of file OutputPage.php.
Referenced by PageDataRequestHandler\httpContentNegotiation().
OutputPage::reduceAllowedModules | ( | $type, | |
$level ) |
Limit the highest level of CSS/JS untrustworthiness allowed.
If passed the same or a higher level than the current level of untrustworthiness set, the level will remain unchanged.
string | $type | |
int | $level | RL\Module class constant |
Definition at line 1759 of file OutputPage.php.
References $type.
OutputPage::returnToMain | ( | $unused = null, | |
$returnto = null, | |||
$returntoquery = null ) |
Add a "return to" link pointing to a specified title, or the title indicated in the request, or else the main page.
mixed | null | $unused | |
PageReference | LinkTarget | string | null | $returnto | Page to return to |
string | null | $returntoquery | Query string for the return to link |
Definition at line 3171 of file OutputPage.php.
References wfCgiToArray().
Referenced by Article\doDelete().
OutputPage::sendCacheControl | ( | ) |
Send cache control HTTP headers.
Definition at line 2682 of file OutputPage.php.
References wfDebug().
Referenced by checkLastModified().
OutputPage::setArticleBodyOnly | ( | $only | ) |
Set whether the output should only contain the body of the article, without any skin, sidebar, etc.
Used e.g. when calling with "action=render".
bool | $only | Whether to output only the body of the article |
Definition at line 762 of file OutputPage.php.
OutputPage::setArticleFlag | ( | $newVal | ) |
Set whether the displayed content is related to the source of the corresponding article on the wiki Setting true will cause the change "article related" toggle to true.
bool | $newVal |
Definition at line 1403 of file OutputPage.php.
OutputPage::setArticleRelated | ( | $newVal | ) |
Set whether this page is related an article on the wiki Setting false will cause the change of "article flag" toggle to false.
bool | $newVal |
Definition at line 1426 of file OutputPage.php.
OutputPage::setCanonicalUrl | ( | $url | ) |
Set the URL to be used for the <link rel=canonical>>.
This should be used in preference to addLink(), to avoid duplicate link tags.
string | $url |
Definition at line 498 of file OutputPage.php.
Referenced by Article\showRedirectedFromHeader().
OutputPage::setCategoryLinks | ( | array | $categories | ) |
Reset the category links (but not the category list) and add $categories.
array | $categories | Mapping category name => sort key |
Definition at line 1593 of file OutputPage.php.
OutputPage::setCdnMaxage | ( | $maxage | ) |
Set the value of the "s-maxage" part of the "Cache-control" HTTP header.
int | $maxage | Maximum cache time on the CDN, in seconds. |
Definition at line 2343 of file OutputPage.php.
OutputPage::setCopyright | ( | $hasCopyright | ) |
Set whether the standard copyright should be shown for the current page.
bool | $hasCopyright |
Definition at line 1447 of file OutputPage.php.
OutputPage::setCopyrightUrl | ( | $url | ) |
Set the copyright URL to send with the output.
Empty string to omit, null to reset.
string | null | $url |
Definition at line 438 of file OutputPage.php.
OutputPage::setDisplayTitle | ( | $html | ) |
Same as page title but only contains name of the page, not any other text.
string | $html | Page title text. |
Definition at line 1117 of file OutputPage.php.
OutputPage::setFeedAppendQuery | ( | $val | ) |
Add default feeds to the page header This is mainly kept for backward compatibility, see OutputPage::addFeedLink() for the new version.
string | false | $val | Query to append to feed links or false to output default links |
Definition at line 1347 of file OutputPage.php.
References $type, and getTitle().
OutputPage::setFileVersion | ( | $file | ) |
Set the displayed file version.
File | null | $file |
Definition at line 1905 of file OutputPage.php.
References $file, File\exists(), and wfSetVar().
OutputPage::setFollowPolicy | ( | $policy | ) |
Set the follow policy for the page, but leave the index policy un- touched.
string | $policy | Either 'follow' or 'nofollow'. |
Definition at line 1024 of file OutputPage.php.
Referenced by setRobotPolicy(), and Article\showMissingArticle().
OutputPage::setHTMLTitle | ( | $name | ) |
"HTML title" means the contents of "<title>".
It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.
string | Message | $name |
Definition at line 1046 of file OutputPage.php.
References getContext().
OutputPage::setIndexPolicy | ( | $policy | ) |
Set the index policy for the page, but leave the follow policy un- touched.
string | $policy | Either 'index' or 'noindex'. |
Definition at line 1002 of file OutputPage.php.
Referenced by setRobotPolicy(), and Article\showMissingArticle().
OutputPage::setIndicators | ( | array | $indicators | ) |
Add an array of indicators, with their identifiers as array keys and HTML contents as values.
In case of duplicate keys, existing values are overwritten.
string[] | $indicators |
Definition at line 1647 of file OutputPage.php.
OutputPage::setLanguageLinks | ( | array | $newLinkArray | ) |
Reset the language links and add new language links.
string[] | $newLinkArray | Array of interwiki-prefixed (non DB key) titles (e.g. 'fr:Test page') |
Definition at line 1480 of file OutputPage.php.
OutputPage::setLastModified | ( | $timestamp | ) |
Override the last modified timestamp.
string | $timestamp | New timestamp, in a format readable by wfTimestamp() |
Definition at line 912 of file OutputPage.php.
References wfTimestamp().
OutputPage::setPageTitle | ( | $name | ) |
"Page title" means the contents of \<h1\>.
It is stored as a valid HTML fragment. This function allows good tags like \<sup\> in the \<h1\> tag, but not bad tags like \<script\>. This function automatically sets \<title\> to the same content as \<h1\> but with all tags removed. Bad tags that were escaped in \<h1\> will still be escaped in \<title\>, and good tags like \<i\> will be dropped entirely.
string | Message | $name | |
-taint | $name | tainted Phan-taint-check gets very confused by $name being either a string or a Message |
Definition at line 1084 of file OutputPage.php.
References getContext().
Referenced by Article\doDelete().
OutputPage::setPreventClickjacking | ( | bool | $enable | ) |
Set the prevent-clickjacking flag.
If true, will cause an X-Frame-Options header appropriate for edit pages to be sent. The header value is controlled by $wgEditPageFrameOptions. This is the default for special pages. If you display a CSRF-protected form on an ordinary view page, then you need to call this function.
Setting this flag to false will turn off frame-breaking. This can be called from pages which do not contain any CSRF-protected HTML form.
bool | $enable | If true, will cause an X-Frame-Options header appropriate for edit pages to be sent. |
Definition at line 2605 of file OutputPage.php.
Referenced by Article\showPatrolFooter().
OutputPage::setPrintable | ( | ) |
Set the page as printable, i.e.
it'll be displayed with all print styles included
Definition at line 1261 of file OutputPage.php.
OutputPage::setProperty | ( | $name, | |
$value ) |
Set an additional output property.
string | $name | |
mixed | $value |
Definition at line 782 of file OutputPage.php.
OutputPage::setRedirectedFrom | ( | PageReference | $t | ) |
Set $mRedirectedFrom, the page which redirected us to the current page.
PageReference | $t |
Definition at line 1068 of file OutputPage.php.
References $t.
Referenced by Article\showRedirectedFromHeader().
OutputPage::setRevisionId | ( | $revid | ) |
Set the revision ID which will be seen by the wiki text parser for things such as embedded {{REVISIONID}} variable use.
int | null | $revid | A positive integer, or null |
Definition at line 1840 of file OutputPage.php.
References wfSetVar().
OutputPage::setRevisionIsCurrent | ( | bool | $isCurrent | ) |
Set whether the revision displayed (as set in ::setRevisionId()) is the latest revision of the page.
bool | $isCurrent |
Definition at line 1860 of file OutputPage.php.
OutputPage::setRevisionTimestamp | ( | $timestamp | ) |
Set the timestamp of the revision which will be displayed.
This is used to avoid a extra DB call in Skin::lastModified().
string | null | $timestamp |
Definition at line 1885 of file OutputPage.php.
References wfSetVar().
OutputPage::setRobotPolicy | ( | $policy | ) |
Set the robot policy for the page: http://www.robotstxt.org/meta.html
string | $policy | The literal string to output as the contents of the meta tag. Will be parsed according to the spec and output in standardized form. |
Definition at line 923 of file OutputPage.php.
References setFollowPolicy(), and setIndexPolicy().
Referenced by Article\doDelete().
OutputPage::setRobotsOptions | ( | array | $options = [] | ) |
Set the robots policy with options for the page.
array | $options | An array of key-value pairs or a string to populate the robots meta tag content attribute as a string. |
Definition at line 971 of file OutputPage.php.
OutputPage::setSections | ( | array | $sections | ) |
Adds sections to OutputPage from ParserOutput.
array | $sections |
Definition at line 2050 of file OutputPage.php.
OutputPage::setStatusCode | ( | $statusCode | ) |
Set the HTTP status code to send with the output.
int | $statusCode |
Definition at line 447 of file OutputPage.php.
OutputPage::setSubtitle | ( | $str | ) |
Replace the subtitle with $str.
string | Message | $str | New value of the subtitle. String should be safe HTML. |
Definition at line 1191 of file OutputPage.php.
OutputPage::setSyndicated | ( | $show = true | ) |
Add or remove feed links in the page header This is mainly kept for backward compatibility, see OutputPage::addFeedLink() for the new version.
bool | $show | True: add default feeds, false: remove all feeds |
Definition at line 1316 of file OutputPage.php.
OutputPage::setTarget | ( | $target | ) |
Sets ResourceLoader target for load.php links.
If null, will be omitted
string | null | $target |
Definition at line 654 of file OutputPage.php.
OutputPage::setTitle | ( | PageReference | $t | ) |
Set the Title object to use.
PageReference | $t |
Definition at line 1178 of file OutputPage.php.
References $t, and getContext().
|
static |
Helper function to setup the PHP implementation of OOUI to use in this request.
string | $skinName | The Skin name to determine the correct OOUI theme |
string | $dir | Language direction |
Definition at line 4397 of file OutputPage.php.
OutputPage::showErrorPage | ( | $title, | |
$msg, | |||
$params = [], | |||
$returnto = null, | |||
$returntoquery = null ) |
Output a standard error page.
showErrorPage( 'titlemsg', 'pagetextmsg' ); showErrorPage( 'titlemsg', 'pagetextmsg', [ 'param1', 'param2' ] ); showErrorPage( 'titlemsg', $messageObject ); showErrorPage( $titleMessageObject, $messageObject );
string | Message | $title | Message key (string) for page title, or a Message object |
string | Message | $msg | Message key (string) for page text, or a Message object |
array | $params | Message parameters; ignored if $msg is a Message object |
PageReference | LinkTarget | string | null | $returnto | Page to show a return link to; defaults to the 'returnto' URL parameter |
string | null | $returntoquery | Query string for the return to link; defaults to the 'returntoquery' URL parameter |
Definition at line 2940 of file OutputPage.php.
References $title.
OutputPage::showFatalError | ( | $message | ) |
Output an error page.
string | $message | Error to output. Must be escaped for HTML. |
Definition at line 3141 of file OutputPage.php.
OutputPage::showLagWarning | ( | $lag | ) |
Show a warning about replica DB lag.
If the lag is higher than $wgDatabaseReplicaLagCritical seconds, then the warning is a bit more obvious. If the lag is lower than $wgDatabaseReplicaLagWarning, then no warning is shown.
int | $lag | Replica lag |
Definition at line 3122 of file OutputPage.php.
OutputPage::showNewSectionLink | ( | ) |
OutputPage::showPermissionsErrorPage | ( | array | $errors, |
$action = null ) |
Output a standard permission error page.
array | $errors | Error message keys or [key, param...] arrays |
string | null | $action | Action that was denied or null if unknown |
Definition at line 2969 of file OutputPage.php.
References $title, getAuthority(), SpecialPage\getTitleFor(), getUser(), PROTO_RELATIVE, and wfArrayToCgi().
OutputPage::showsCopyright | ( | ) |
Return whether the standard copyright should be shown for the current page.
By default, it is true for all articles but other pages can signal it by using setCopyright( true ).
Used by SkinTemplate to decided whether to show the copyright.
Definition at line 1460 of file OutputPage.php.
|
protected |
Generate \<link\> tags for stylesheets.
string | $style | URL to the file |
array | $options | Option, can contain 'condition', 'dir', 'media' keys |
Definition at line 4165 of file OutputPage.php.
OutputPage::tailElement | ( | $skin | ) |
The final bits that go to the bottom of a page HTML document including the closing tags.
Skin | $skin |
Definition at line 4458 of file OutputPage.php.
References wfReportTime().
|
static |
Transform "media" attribute based on request parameters.
string | $media | Current value of the "media" attribute |
Definition at line 4284 of file OutputPage.php.
References $wgRequest.
|
static |
Utility method for transformResourceFilePath().
Caller is responsible for ensuring the file exists. Emits a PHP warning otherwise.
string | $remotePathPrefix | URL path prefix that points to $localPath |
string | $localPath | File directory exposed at $remotePath |
string | $file | Path to target file relative to $localPath |
Definition at line 4262 of file OutputPage.php.
References wfLogWarning().
|
static |
Transform path to web-accessible static resource.
This is used to add a validation hash as query string. This aids various behaviors:
Avoid using this for urls included in HTML as otherwise clients may get different versions of a resource when navigating the site depending on when the page was cached. If changes to the url propagate, this is not a problem (e.g. if the url is in an external stylesheet).
Config | $config | |
string | $path | Path-absolute URL to file (from document root, must start with "/") |
Definition at line 4222 of file OutputPage.php.
References $path, and Config\get().
OutputPage::userCanPreview | ( | ) |
To make it harder for someone to slip a user a fake JavaScript or CSS preview, a random token is associated with the login session.
If it's not passed back with the preview request, we won't render the code.
Definition at line 3728 of file OutputPage.php.
References $title, getAuthority(), getTitle(), and getUser().
OutputPage::versionRequired | ( | $version | ) |
Display an error page indicating that a given version of MediaWiki is required to use it.
mixed | $version | The version of MediaWiki needed to use the page |
Definition at line 3052 of file OutputPage.php.
OutputPage::wrapWikiMsg | ( | $wrap, | |
$msgSpecs ) |
This function takes a number of message/argument specifications, wraps them in some overall structure, and then parses the result and adds it to the output.
In the $wrap, $1 is replaced with the first message, $2 with the second, and so on. The subsequent arguments may be either 1) strings, in which case they are message names, or 2) arrays, in which case, within each array, the first element is the message name, and subsequent elements are the parameters to that message.
Don't use this for messages that are not in the user's interface language.
For example:
$wgOut->wrapWikiMsg( "<div class='customclass'>\\n$1\\n</div>", 'some-msg-key' );
Is equivalent to:
$wgOut->addWikiTextAsInterface( "<div class='customclass'>\\n" . wfMessage( 'some-msg-key' )->plain() . "\\n</div>" );
The newline after the opening div is needed in some wikitext. See T21226.
string | $wrap | |
mixed | ...$msgSpecs |
Definition at line 4366 of file OutputPage.php.
OutputPage::wrapWikiTextAsInterface | ( | $wrapperClass, | |
$text ) |
Convert wikitext in the user interface language to HTML and add it to the buffer with a <div class="$wrapperClass">
wrapper.
The result will not be language-converted, as user interface messages as already localized into a specific variant. The $text will be parsed in start-of-line context. Output will be tidy.
string | $wrapperClass | The class attribute value for the wrapper in the output HTML |
string | $text | Wikitext in the user interface language |
Definition at line 1983 of file OutputPage.php.
References getTitle().
Referenced by Article\doDelete().
|
protected |
Additional <body> classes; there are also <body> classes from other sources.
Definition at line 189 of file OutputPage.php.
|
protected |
Additional <html> classes; This should be rarely modified; prefer mAdditionalBodyClasses.
Definition at line 180 of file OutputPage.php.
|
protected |
What level of 'untrustworthiness' is allowed in CSS/JS modules loaded on this page?
Definition at line 240 of file OutputPage.php.
string OutputPage::$mBodytext = '' |
Contains all of the "<body>" content.
Should be private we got set/get accessors and the append() method.
Definition at line 87 of file OutputPage.php.
|
protected |
Definition at line 64 of file OutputPage.php.
|
protected |
Definition at line 143 of file OutputPage.php.
|
protected |
Definition at line 137 of file OutputPage.php.
|
protected |
|
protected |
Upper limit on mCdnMaxage.
Definition at line 296 of file OutputPage.php.
|
protected |
Whether output is disabled.
If this is true, the 'output' method will do nothing.
Definition at line 245 of file OutputPage.php.
|
protected |
Set to false to send no-cache headers, disabling client-side caching.
(This variable should really be named in the opposite sense; see ::disableClientCache().)
Definition at line 268 of file OutputPage.php.
|
protected |
Definition at line 233 of file OutputPage.php.
|
protected |
Definition at line 315 of file OutputPage.php.
|
protected |
Array of elements in "<head>".
Parser might add its own headers!
Definition at line 186 of file OutputPage.php.
|
protected |
Definition at line 283 of file OutputPage.php.
|
protected |
Definition at line 228 of file OutputPage.php.
|
protected |
Definition at line 152 of file OutputPage.php.
|
protected |
|
protected |
Definition at line 219 of file OutputPage.php.
|
protected |
Used for sending cache control.
The whole caching system should probably be moved into its own class.
Definition at line 131 of file OutputPage.php.
|
protected |
Definition at line 61 of file OutputPage.php.
|
protected |
Should be private.
Used with addMeta() which adds "<meta>"
Definition at line 58 of file OutputPage.php.
|
protected |
Definition at line 195 of file OutputPage.php.
|
protected |
Definition at line 201 of file OutputPage.php.
|
protected |
Definition at line 277 of file OutputPage.php.
bool OutputPage::$mNoGallery = false |
Comes from the parser.
This was probably made to load CSS/JS only if we had "<gallery>". Used directly in CategoryPage.php. Looks like ResourceLoader can replace this.
Definition at line 291 of file OutputPage.php.
string OutputPage::$mPageLinkTitle = '' |
Used by skin template.
Example: $tpl->set( 'displaytitle', $out->mPageLinkTitle );
Definition at line 174 of file OutputPage.php.
|
protected |
lazy initialised, use parserOptions()
Definition at line 253 of file OutputPage.php.
|
protected |
Controls if anti-clickjacking / frame-breaking headers will be sent.
This should be done for pages where edit actions are possible. Setter: $this->setPreventClickjacking()
Definition at line 303 of file OutputPage.php.
string OutputPage::$mRedirect = '' |
Definition at line 122 of file OutputPage.php.
string OutputPage::$mRedirectCode = '' |
Definition at line 231 of file OutputPage.php.
|
protected |
Definition at line 204 of file OutputPage.php.
|
protected |
Definition at line 125 of file OutputPage.php.
|
protected |
Definition at line 225 of file OutputPage.php.
|
protected |
An array of stylesheet filenames (relative from skins path), with options for CSS media, IE conditions, and RTL/LTR direction.
For internal use; add settings in the skin via $this->addStyle()
Style again! This seems like a code duplication since we already have mStyles. This is what makes Open Source amazing.
Definition at line 325 of file OutputPage.php.