This class should be covered by a general architecture document which does not exist as of January 2011. More...

Inheritance diagram for OutputPage:

Collaboration diagram for OutputPage:

Public Member Functions
	__construct (IContextSource $context=null)
	Constructor for OutputPage.
	addAcceptLanguage ()
	bug 21672: Add Accept-Language to Vary and XVO headers if there's no 'variant' parameter existed in GET.
	addBacklinkSubtitle (Title $title)
	Add a subtitle containing a backlink to a page.
	addCategoryLinks ($categories)
	Add an array of categories, with names in the keys.
	addElement ($element, $attribs=array(), $contents= '')
	Shortcut for adding an Html::element via addHTML.
	addExtensionStyle ($url)
	Register and add a stylesheet from an extension directory.
	addFeedLink ($format, $href)
	Add a feed link to the page header.
	addHeadItem ($name, $value)
	Add or replace an header item to the output.
	addHTML ($text)
	Append $text to the body HTML.
	addInlineScript ($script)
	Add a self-contained script tag with the given contents.
	addInlineStyle ($style_css, $flip= 'noflip')
	Adds inline CSS styles.
	addJsConfigVars ($keys, $value=null)
	Add one or more variables to be set in mw.config in JavaScript.
	addKeyword ($text)
	Add a keyword or a list of keywords in the page header.
	addLanguageLinks ($newLinkArray)
	Add new language links.
	addLink ($linkarr)
	Add a new <link> tag to the page header.
	addMeta ($name, $val)
	Add a new "<meta>" tag To add an http-equiv meta tag, precede the name with "http:".
	addMetadataLink ($linkarr)
	Add a new <link> with "rel" attribute set to "meta".
	addModuleMessages ($modules)
	Add only messages of one or more modules recognized by the resource loader.
	addModules ($modules)
	Add one or more modules recognized by the resource loader.
	addModuleScripts ($modules)
	Add only JS of one or more modules recognized by the resource loader.
	addModuleStyles ($modules)
	Add only CSS of one or more modules recognized by the resource loader.
	addParserOutput (&$parserOutput)
	Add a ParserOutput object.
	addParserOutputNoText (&$parserOutput)
	Add a ParserOutput object, but without Html.
	addReturnTo ($title, $query=array(), $text=null)
	Add a "return to" link pointing to a specified title.
	addScript ($script)
	Add raw HTML to the list of scripts (including <script> tag, etc.)
	addScriptFile ($file, $version=null)
	Add a JavaScript file out of skins/common, or a given relative path.
	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, $option=null)
	Add an HTTP header that will influence on the cache.
	addWikiMsg ()
	Add a wikitext-formatted message to the output.
	addWikiMsgArray ($name, $args)
	Add a wikitext-formatted message to the output.
	addWikiText ($text, $linestart=true, $interface=true)
	Convert wikitext to HTML and add it to the buffer Default assumes that the current page title will be used.
	addWikiTextTidy ($text, $linestart=true)
	Add wikitext with tidy enabled.
	addWikiTextTitle ($text, &$title, $linestart, $tidy=false, $interface=false)
	Add wikitext with a custom Title object.
	addWikiTextTitleTidy ($text, &$title, $linestart=true)
	Add wikitext with a custom Title object and tidy enabled.
	addWikiTextWithTitle ($text, &$title, $linestart=true)
	Add wikitext with a custom Title object.
	allowClickjacking ()
	Turn off frame-breaking.
	appendSubtitle ($str)
	Add $str to the subtitle.
	blockedPage ()
	Produce a "user is blocked" page.
	buildCssLinks ()
	Build a set of "<link>" elements for the stylesheets specified in the $this->styles array.
	buildCssLinksArray ()
	checkLastModified ($timestamp)
	checkLastModified tells the client to use the client-cached page if possible.
	clearHTML ()
	Clear the body HTML.
	clearSubtitle ()
	Clear the subtitles.
	disable ()
	Disable output completely, i.e.
	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.
	forceHideNewSectionLink ()
	Forcibly hide the new section link?
	formatPermissionsErrorMessage ($errors, $action=null)
	Format a list of error messages.
	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 cookies that will influence on the cache.
	getCategories ()
	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.
	getExtStyle ()
	Get all styles added by extensions.
	getFeedAppendQuery ()
	Will currently always return null.
	getFileSearchOptions ()
	Get the files used on this page.
	getFileVersion ()
	Get the displayed file version.
	getFrameOptions ()
	Get the X-Frame-Options header value (without the name part), or false if there isn't one.
	getHeadItems ()
	Get all header items in a string.
	getHeadItemsArray ()
	Get an array of head items.
	getHeadLinks ($unused=null, $addContentType=false)
	getHeadLinksArray ($addContentType=false)
	getHeadScripts ()
	JS stuff to put in the "<head>".
	getHTML ()
	Get the body HTML.
	getHTMLTitle ()
	Return the "HTML title", i.e.
	getJSVars ()
	Get an array containing the variables to be set in mw.config in JavaScript.
	getLanguageLinks ()
	Get the list of language links.
	getMetadataAttribute ()
	Get the value of the "rel" attribute for metadata links.
	getModuleMessages ($filter=false, $position=null)
	Get the list of module messages to include on this page.
	getModules ($filter=false, $position=null, $param= 'mModules')
	Get the list of modules to include on this page.
	getModuleScripts ($filter=false, $position=null)
	Get the list of module JS to include on this page.
	getModuleStyles ($filter=false, $position=null)
	Get the list of module CSS to include on this page.
	getPageTitle ()
	Return the "page title", i.e.
	getPageTitleActionText ()
	Get the value of the "action text".
	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.
	getScript ()
	Get all registered JS and CSS tags for the header.
	getScriptsForBottomQueue ($inHead)
	JS stuff to put at the 'bottom', which can either be the bottom of the "<body>" or the bottom of the "<head>" depending on $wgResourceLoaderExperimentalAsyncLoading: modules marked with position 'bottom', legacy scripts ($this->mScripts), user preferences, site JS and user JS.
	getSubtitle ()
	Get the subtitle.
	getSyndicationLinks ()
	Return URLs for each supported syndication format for this page.
	getTemplateIds ()
	Get the templates used on this page.
	getVaryHeader ()
	Return a Vary: header on which to vary caches.
	getXVO ()
	Get a complete X-Vary-Options header.
	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)
	includeJQuery ($modules=array())
	Include jQuery core.
	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".
	isSyndicated ()
	Should we output feed links for this page?
	isUserJsAllowed ()
	Return whether user JavaScript is allowed for this page.
	loginToUse ()
	Produce the stock "please login to use the wiki" page.
	out ($ins)
	Actually output something with print().
	output ()
	Finally, all the text has been munged and accumulated into the object, let's actually output it:
	parse ($text, $linestart=true, $interface=false, $language=null)
	Parse wikitext and return the HTML.
	parseInline ($text, $linestart=true, $interface=false)
	Parse wikitext, strip paragraphs, and return the HTML.
	parserOptions ($options=null)
	Get/set the ParserOptions object to use for wikitext parsing.
	permissionRequired ($permission)
	Display an error page noting that a given permission bit is required.
	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.
	rateLimited ()
	Turn off regular page output and return an error reponse for when rate limiting has triggered.
	readOnlyPage ($source=null, $protected=false, $reasons=array(), $action=null)
	Display a page stating that the Wiki is in read-only mode, and optionally show the source of the page that the user was trying to edit.
	redirect ($url, $responsecode= '302')
	Redirect to $url rather than displaying the normal page.
	reduceAllowedModules ($type, $level)
	As for setAllowedModules(), but don't inadvertantly make the page more accessible.
	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.
	setAllowedModules ($type, $level)
	Set the highest level of CSS/JS untrustworthiness allowed.
	setArticleBodyOnly ($only)
	Set whether the output should only contain the body of the article, without any skin, sidebar, etc.
	setArticleFlag ($v)
	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 ($v)
	Set whether this page is related an article on the wiki Setting false will cause the change of "article flag" toggle to false.
	setCategoryLinks ($categories)
	Reset the category links (but not the category list) and add $categories.
	setETag ($tag)
	Set the value of the ETag HTTP header, only used if $wgUseETag is true.
	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.
	setLanguageLinks ($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>.
	setPageTitleActionText ($text)
	Set the new value of the "action text", this will be added to the "HTML title", separated from it with " - ".
	setPrintable ()
	Set the page as printable, i.e.
	setRedirectedFrom ($t)
	Set $mRedirectedFrom, the Title of 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.
	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>
	setSquidMaxage ($maxage)
	Set the value of the "s-maxage" part of the "Cache-control" HTTP header.
	setStatusCode ($statusCode)
	Set the HTTP status code to send with the output.
	setSubtitle ($str)
	Replace the subtile 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.
	setTitle (Title $t)
	Set the Title object to use.
	showErrorPage ($title, $msg, $params=array())
	Output a standard error page.
	showFatalError ($message)
	showFileCopyError ($old, $new)
	showFileDeleteError ($name)
	showFileNotFoundError ($name)
	showFileRenameError ($old, $new)
	showLagWarning ($lag)
	Show a warning about slave lag.
	showNewSectionLink ()
	Show an "add new section" link?
	showPermissionsErrorPage ($errors, $action=null)
	Output a standard permission error page.
	showUnexpectedValueError ($name, $val)
	userCanPreview ()
	To make it harder for someone to slip a user a fake user-JavaScript or user-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)
	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.
Static Public Member Functions
static	getStatusMessage ($code)
	Get the message associed with the HTTP response code $code.
static	transformCssMedia ($media)
	Transform "media" attribute based on request parameters.
Public Attributes
	$mArticleBodyOnly = false
	Flag if output should only contain the body of the article.
	$mBodytext = ''
	Contains all of the "<body>" content. Should be private we got set/get accessors and the append() method.
	$mCategories = array()
	$mCategoryLinks = array()
	$mContainsNewMagic = 0
	$mContainsOldMagic = 0
	$mDebugtext = ''
	Holds the debug lines that will be output as comments in page source if $wgDebugComments is enabled.
	$mDoNothing = false
	I just love the name for this self documenting variable.
	$mEnableClientCache = true
	$mETag = false
	Should be private.
	$mExtStyles = array()
	Additional stylesheets. Looks like this is for extensions. Might be replaced by resource loader.
	$mFeedLinks = array()
	Handles the atom / rss links.
	$mFeedLinksAppendQuery = null
	$mFileVersion = null
	$mHeadItems = array()
	Array of elements in "<head>". Parser might add its own headers!
	$mHideNewSectionLink = false
	$mHTMLtitle = ''
	Should be private. Stores contents of "<title>" tag.
	$mImageTimeKeys = array()
	$mInlineMsg = array()
	$mInlineStyles = ''
	Inline CSS styles.
	$mIsarticle = false
	Should be private. Is the displayed content related to the source of the corresponding wiki article.
	$mIsArticleRelated = true
	Should be private.
	$mJsConfigVars = array()
	$mKeywords = array()
	"<meta keywords='stuff'>" most of the time the first 10 links to an article
	$mLanguageLinks = array()
	Should be private. Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page')
	$mLastModified = ''
	mLastModified and mEtag are used for sending cache control.
	$mLinkColours
	$mLinktags = array()
	$mMetatags = array()
	Should be private. Used with addMeta() which adds "<meta>".
	$mModuleMessages = array()
	$mModules = array()
	$mModuleScripts = array()
	$mModuleStyles = array()
	$mNewSectionLink = false
	$mNoGallery = false
	Comes from the parser.
	$mPageLinkTitle = ''
	Used by skin template.
	$mPagetitle = ''
	Should be private - has getter and setter. Contains the HTML title.
	$mPageTitleActionText = ''
	$mParseWarnings = array()
	$mPreventClickjacking = true
	$mPrintable = false
	Should be private.
	$mRedirect = ''
	$mRedirectCode = ''
	$mResourceLoader
	$mRevisionId = null
	should be private. To include the variable {{REVISIONID}}
	$mScripts = ''
	Should be private.
	$mSquidMaxage = 0
	$mStatusCode
	$mTemplateIds = array()
	$styles = array()
	An array of stylesheet filenames (relative from skins path), with options for CSS media, IE conditions, and RTL/LTR direction.
Protected Member Functions
	filterModules ($modules, $position=null, $type=ResourceLoaderModule::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)
	makeResourceLoaderLink ($modules, $only, $useESI=false, array $extraQuery=array(), $loadCall=false)
	TODO: Document.
	styleLink ($style, $options)
	Generate <link> tags for stylesheets.
Protected Attributes
	$mAllowedModules
	$mJQueryDone = false
	Whether jQuery is already handled.
ParserOptions	$mParserOptions = null
	lazy initialised, use parserOptions()
Private Member Functions
	addDefaultModules ()
	Add the default ResourceLoader modules to this object.
	feedLink ($type, $url, $text)
	Generate a "<link rel/>" for a feed.
Private Attributes
	$mFollowPolicy = 'follow'
	$mIndexPolicy = 'index'
Title	$mRedirectedFrom = null
	If the current page was reached through a redirect, $mRedirectedFrom contains the Title of the redirect.
	$mRevisionTimestamp = null
	$mSubtitle = array()
	Should be private.
	$mVaryHeader

Detailed Description

This class should be covered by a general architecture document which does not exist as of January 2011.

This is one of the Core classes and should be read at least once by any new developers.

This class is used to prepare the final rendering. A skin is then applied to the output parameters (links, javascript, html, categories ...).

Todo:: FIXME: Another class handles sending the whole page to the client.

Some comments comes from a pairing session between Zak Greant and Antoine Musso in November 2010.

Todo:: document

Definition at line 38 of file OutputPage.php.

Constructor & Destructor Documentation

OutputPage::__construct ( IContextSource $ context = null )

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.

Definition at line 253 of file OutputPage.php.

Member Function Documentation

OutputPage::addAcceptLanguage ( )

bug 21672: Add Accept-Language to Vary and XVO headers if there's no 'variant' parameter existed in GET.

For example: /w/index.php?title=Main_page should always be served; but /w/index.php?title=Main_page&variant=zh-cn should never be served.

Definition at line 1759 of file OutputPage.php.

OutputPage::addBacklinkSubtitle ( Title $ title )

Add a subtitle containing a backlink to a page.

Parameters:

$title Title to link to

Definition at line 891 of file OutputPage.php.

OutputPage::addCategoryLinks ( $ categories )

Add an array of categories, with names in the keys.

Parameters:

$categories Array mapping category name => sort key

Definition at line 1124 of file OutputPage.php.

OutputPage::addDefaultModules ( ) [private]

Add the default ResourceLoader modules to this object.

Definition at line 2450 of file OutputPage.php.

OutputPage::addElement	(	$	element,
		$	attribs = `array()`,
		$	contents = `''`
	)

Shortcut for adding an Html::element via addHTML.

Since:: 1.19

Parameters:

$element	string
$attribs	array
$contents	string

Definition at line 1295 of file OutputPage.php.

OutputPage::addExtensionStyle ( $ url )

Register and add a stylesheet from an extension directory.

Parameters:

$url	String path to sheet. Provide either a full url (beginning with 'http', etc) or a relative path from the document root (beginning with '/'). Otherwise it behaves identically to addStyle() and draws from the /skins folder.

Definition at line 370 of file OutputPage.php.

OutputPage::addFeedLink	(	$	format,
		$	href
	)

Add a feed link to the page header.

Parameters:

$format	String: feed type, should be a key of $wgFeedClasses
$href	String: URL

Definition at line 1011 of file OutputPage.php.

OutputPage::addHeadItem	(	$	name,
		$	value
	)

Add or replace an header item to the output.

Parameters:

$name	String: item name
$value	String: raw HTML

Definition at line 567 of file OutputPage.php.

Referenced by SkinVector\initPage().

OutputPage::addHTML ( $ text )

Append $text to the body HTML.

Parameters:

$text String: HTML

Definition at line 1282 of file OutputPage.php.

OutputPage::addInlineScript ( $ script )

Add a self-contained script tag with the given contents.

Parameters:

$script String: JavaScript text, no "<script>" tags

Definition at line 408 of file OutputPage.php.

OutputPage::addInlineStyle	(	$	style_css,
		$	flip = `'noflip'`
	)

Adds inline CSS styles.

Parameters:

$style_css	Mixed: inline CSS
$flip	String: Set to 'flip' to flip the CSS if needed

Definition at line 3302 of file OutputPage.php.

Referenced by SkinStandard\setupSkinUserCss(), SkinCologneBlue\setupSkinUserCss(), and SkinSimple\setupSkinUserCss().

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

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

Parameters:

$keys	{String\|Array} Key or array of key/value pairs.
$value	{Mixed} [optional] Value of the configuration variable.

Definition at line 2880 of file OutputPage.php.

OutputPage::addKeyword ( $ text )

Add a keyword or a list of keywords in the page header.

Parameters:

$text String or array of strings

Definition at line 308 of file OutputPage.php.

OutputPage::addLanguageLinks ( $ newLinkArray )

Add new language links.

Parameters:

$newLinkArray array Associative array mapping language code to the page name

Definition at line 1096 of file OutputPage.php.

OutputPage::addLink ( $ linkarr )

Add a new <link> tag to the page header.

Parameters:

$linkarr Array: associative array of attributes.

Definition at line 321 of file OutputPage.php.

OutputPage::addMeta	(	$	name,
		$	val
	)

Add a new "<meta>" tag To add an http-equiv meta tag, precede the name with "http:".

Parameters:

$name	String tag name
$val	String tag value

Definition at line 299 of file OutputPage.php.

OutputPage::addMetadataLink ( $ linkarr )

Add a new <link> with "rel" attribute set to "meta".

Parameters:

$linkarr Array: associative array mapping attribute names to their values, both keys and values will be escaped, and the "rel" attribute will be automatically added

Definition at line 332 of file OutputPage.php.

OutputPage::addModuleMessages ( $ modules )

Add only messages of one or more modules recognized by the resource loader.

Module messages added through this function will be loaded by the resource loader when the page loads.

Parameters:

$modules Mixed: module name (string) or array of module names

Definition at line 535 of file OutputPage.php.

OutputPage::addModules ( $ modules )

Add one or more modules recognized by the resource loader.

Modules added through this function will be loaded by the resource loader when the page loads.

Parameters:

$modules Mixed: module name (string) or array of module names

Definition at line 466 of file OutputPage.php.

Referenced by MWDebug\addModules().

OutputPage::addModuleScripts ( $ modules )

Add only JS of one or more modules recognized by the resource loader.

Module scripts added through this function will be loaded by the resource loader when the page loads.

Parameters:

$modules Mixed: module name (string) or array of module names

Definition at line 489 of file OutputPage.php.

Referenced by SkinVector\initPage().

OutputPage::addModuleStyles ( $ modules )

Add only CSS of one or more modules recognized by the resource loader.

Module styles added through this function will be loaded by the resource loader when the page loads.

Parameters:

$modules Mixed: module name (string) or array of module names

Definition at line 512 of file OutputPage.php.

Referenced by SkinStandard\setupSkinUserCss(), SkinLegacy\setupSkinUserCss(), SkinChick\setupSkinUserCss(), SkinNostalgia\setupSkinUserCss(), SkinCologneBlue\setupSkinUserCss(), SkinModern\setupSkinUserCss(), SkinSimple\setupSkinUserCss(), SkinMonoBook\setupSkinUserCss(), SkinVector\setupSkinUserCss(), and SkinTemplate\setupSkinUserCss().

OutputPage::addParserOutput ( &$ parserOutput )

Add a ParserOutput object.

Parameters:

$parserOutput ParserOutput

Definition at line 1544 of file OutputPage.php.

OutputPage::addParserOutputNoText ( &$ parserOutput )

Add a ParserOutput object, but without Html.

Parameters:

$parserOutput ParserOutput object

Definition at line 1497 of file OutputPage.php.

OutputPage::addReturnTo	(	$	title,
		$	query = `array()`,
		$	text = `null`
	)

Add a "return to" link pointing to a specified title.

Parameters:

$title	Title to link
$query	Array query string parameters
$text	String text of the link (input is not escaped)

Definition at line 2345 of file OutputPage.php.

OutputPage::addScript ( $ script )

Add raw HTML to the list of scripts (including <script> tag, etc.)

Parameters:

$script String: raw HTML

Definition at line 358 of file OutputPage.php.

OutputPage::addScriptFile	(	$	file,
		$	version = `null`
	)

Add a JavaScript file out of skins/common, or a given relative path.

Parameters:

$file	String: filename in skins/common or complete on-server path (/foo/bar.js)
$version	String: style version of the file. Defaults to $wgStyleVersion

Definition at line 390 of file OutputPage.php.

OutputPage::addStyle	(	$	style,
		$	media = `''`,
		$	condition = `''`,
		$	dir = `''`
	)

Add a local or specified stylesheet, with the given media options.

Meant primarily for internal use...

Parameters:

$style	String: URL to the file
$media	String: to specify a media type, 'screen', 'printable', 'handheld' or any.
$condition	String: for IE conditional comments, specifying an IE version
$dir	String: set to 'rtl' or 'ltr' for direction-specific sheets

Definition at line 3281 of file OutputPage.php.

Referenced by SkinChick\setupSkinUserCss(), and SkinMonoBook\setupSkinUserCss().

OutputPage::addSubtitle ( $ str )

Add $str to the subtitle.

Parameters:

$str	String\|Message to add to the subtitle

Definition at line 878 of file OutputPage.php.

OutputPage::addTemplate ( &$ template )

Add the output of a QuickTemplate to the output buffer.

Parameters:

$template QuickTemplate

Definition at line 1557 of file OutputPage.php.

OutputPage::addVaryHeader	(	$	header,
		$	option = `null`
	)

Add an HTTP header that will influence on the cache.

Parameters:

$header	String: header name
$option	Array\|null

Todo:: FIXME: Document the $option parameter; it appears to be for X-Vary-Options but what format is acceptable?

Definition at line 1701 of file OutputPage.php.

OutputPage::addWikiMsg ( )

Add a wikitext-formatted message to the output.

This is equivalent to:

$wgOut->addWikiText( wfMessage( ... )->plain() )

Definition at line 3511 of file OutputPage.php.

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.

Parameters:

$name	string
$args	array

Definition at line 3525 of file OutputPage.php.

OutputPage::addWikiText	(	$	text,
		$	linestart = `true`,
		$	interface = `true`
	)

Convert wikitext to HTML and add it to the buffer Default assumes that the current page title will be used.

Parameters:

$text	String
$linestart	Boolean: is this the start of a line?
$interface	Boolean: is this text in the user interface language?

Definition at line 1423 of file OutputPage.php.

OutputPage::addWikiTextTidy	(	$	text,
		$	linestart = `true`
	)

Add wikitext with tidy enabled.

Parameters:

$text	String: wikitext
$linestart	Boolean: is this the start of a line?

Definition at line 1456 of file OutputPage.php.

OutputPage::addWikiTextTitle	(	$	text,
		&$	title,
		$	linestart,
		$	tidy = `false`,
		$	interface = `false`
	)

Add wikitext with a custom Title object.

Parameters:

$text	String: wikitext
$title	Title object
$linestart	Boolean: is this the start of a line?
$tidy	Boolean: whether to use tidy
$interface	Boolean: whether it is an interface message (for example disables conversion)

Definition at line 1471 of file OutputPage.php.

OutputPage::addWikiTextTitleTidy	(	$	text,
		&$	title,
		$	linestart = `true`
	)

Add wikitext with a custom Title object and tidy enabled.

Parameters:

$text	String: wikitext
$title	Title object
$linestart	Boolean: is this the start of a line?

Definition at line 1446 of file OutputPage.php.

OutputPage::addWikiTextWithTitle	(	$	text,
		&$	title,
		$	linestart = `true`
	)

Add wikitext with a custom Title object.

Parameters:

$text	String: wikitext
$title	Title object
$linestart	Boolean: is this the start of a line?

Definition at line 1435 of file OutputPage.php.

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 1804 of file OutputPage.php.

OutputPage::appendSubtitle ( $ str )

Add $str to the subtitle.

Deprecated:: in 1.19; use addSubtitle() instead

Parameters:

$str	String\|Message to add to the subtitle

Definition at line 869 of file OutputPage.php.

OutputPage::blockedPage ( )

Produce a "user is blocked" page.

Deprecated:: since 1.18

Definition at line 2012 of file OutputPage.php.

OutputPage::buildCssLinks ( )

Build a set of "<link>" elements for the stylesheets specified in the $this->styles array.

These will be applied to various media & IE conditionals.

Returns:: string

Definition at line 3316 of file OutputPage.php.

OutputPage::buildCssLinksArray ( )

Returns:: Array

Definition at line 3406 of file OutputPage.php.

OutputPage::checkLastModified ( $ timestamp )

checkLastModified tells the client to use the client-cached page if possible.

If sucessful, the OutputPage is disabled so that any future call to OutputPage->output() have no effect.

Side effect: sets mLastModified for Last-Modified header

Parameters:

$timestamp string

Returns:: Boolean: true iff cache-ok headers was sent.

Definition at line 621 of file OutputPage.php.

OutputPage::clearHTML ( )

Clear the body HTML.

Definition at line 1302 of file OutputPage.php.

OutputPage::clearSubtitle ( )

Clear the subtitles.

Definition at line 902 of file OutputPage.php.

OutputPage::disable ( )

Disable output completely, i.e.

calling output() will have no effect

Definition at line 935 of file OutputPage.php.

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.

Definition at line 1215 of file OutputPage.php.

OutputPage::enableClientCache ( $ state )

Use enableClientCache(false) to force it to send nocache headers.

Parameters:

$state bool

Returns:: bool

Definition at line 1644 of file OutputPage.php.

OutputPage::feedLink	(	$	type,
		$	url,
		$	text
	)		`[private]`

Generate a "<link rel/>" for a feed.

Parameters:

$type	String: feed type
$url	String: URL to the feed
$text	String: value of the "title" attribute

Returns:: String: HTML fragment

Definition at line 3263 of file OutputPage.php.

OutputPage::filterModules	(	$	modules,
		$	position = `null`,
		$	type = `ResourceLoaderModule::TYPE_COMBINED`
	)		`[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)

Parameters:

$modules	Array
$position	String if not null, only return modules with this position
$type	string

Returns:: Array

Definition at line 429 of file OutputPage.php.

OutputPage::forceHideNewSectionLink ( )

Forcibly hide the new section link?

Returns:: Boolean

Definition at line 962 of file OutputPage.php.

OutputPage::formatPermissionsErrorMessage	(	$	errors,
		$	action = `null`
	)

Format a list of error messages.

Parameters:

$errors	Array of arrays returned by Title::getUserPermissionsErrors
$action	String: action that was denied or null if unknown

Returns:: String: the wikitext error-messages, formatted into a list.

Definition at line 2178 of file OutputPage.php.

OutputPage::getAllowedModules ( $ type )

Show what level of JavaScript / CSS untrustworthiness is allowed on this page.

See also:: ResourceLoaderModule::$origin

Parameters:

$type String ResourceLoaderModule TYPE_ constant

Returns:: Int ResourceLoaderModule ORIGIN_ class constant

Definition at line 1240 of file OutputPage.php.

OutputPage::getArticleBodyOnly ( )

Return whether the output will contain only the body of the article.

Returns:: Boolean

Definition at line 606 of file OutputPage.php.

OutputPage::getBottomScripts ( )

JS stuff to put at the bottom of the "<body>".

Returns:: string

Definition at line 2865 of file OutputPage.php.

OutputPage::getCacheVaryCookies ( )

Get the list of cookies that will influence on the cache.

Returns:: Array

Definition at line 1653 of file OutputPage.php.

OutputPage::getCategories ( )

Get the list of category names this page belongs to.

Returns:: Array of strings

Definition at line 1207 of file OutputPage.php.

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.

Returns:: Array

Definition at line 1198 of file OutputPage.php.

OutputPage::getExtStyle ( )

Get all styles added by extensions.

Returns:: Array

Definition at line 379 of file OutputPage.php.

OutputPage::getFeedAppendQuery ( )

Will currently always return null.

Returns:: null

Definition at line 1040 of file OutputPage.php.

OutputPage::getFileSearchOptions ( )

Get the files used on this page.

Returns:: Array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))

Since:: 1.18

Definition at line 1411 of file OutputPage.php.

OutputPage::getFileVersion ( )

Get the displayed file version.

Returns:: Array|null ('time' => MW timestamp, 'sha1' => sha1)

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

Returns:: string

Definition at line 1815 of file OutputPage.php.

OutputPage::getHeadItems ( )

Get all header items in a string.

Returns:: String

Definition at line 553 of file OutputPage.php.

OutputPage::getHeadItemsArray ( )

Get an array of head items.

Returns:: Array

Definition at line 544 of file OutputPage.php.

Referenced by ParserOutput\addOutputPageMetadata().

OutputPage::getHeadLinks	(	$	unused = `null`,
		$	addContentType = `false`
	)

Parameters:

$unused
$addContentType	bool: Whether "<meta>" specifying content type should be returned

Returns:: string HTML tag links to be put in the header.

Definition at line 3251 of file OutputPage.php.

OutputPage::getHeadLinksArray ( $ addContentType = false )

Parameters:

$addContentType bool: Whether "<meta>" specifying content type should be returned

Returns:: array in format "link name or number => 'link html'".

Definition at line 3017 of file OutputPage.php.

OutputPage::getHeadScripts ( )

JS stuff to put in the "<head>".

This is the startup module, config vars and modules marked with position 'top'

Returns:: String: HTML fragment

Definition at line 2698 of file OutputPage.php.

OutputPage::getHTML ( )

Get the body HTML.

Returns:: String: HTML

Definition at line 1311 of file OutputPage.php.

OutputPage::getHTMLTitle ( )

Return the "HTML title", i.e.

the content of the "<title>" tag.

Returns:: String

Definition at line 799 of file OutputPage.php.

OutputPage::getJSVars ( )

Get an array containing the variables to be set in mw.config in JavaScript.

DO NOT CALL THIS FROM OUTSIDE OF THIS CLASS OR Skin::makeGlobalVariablesScript(). This is only public until that function is removed. You have been warned.

Do not add things here which can be evaluated in ResourceLoaderStartupScript

in other words, page-independent/site-wide variables (without state). You will only be adding bloat to the html page and causing page caches to have to be purged on configuration changes.
Returns:
array

Definition at line 2904 of file OutputPage.php.

OutputPage::getLanguageLinks ( )

Get the list of language links.

Returns:: Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page')

Definition at line 1115 of file OutputPage.php.

OutputPage::getMetadataAttribute ( )

Get the value of the "rel" attribute for metadata links.

Returns:: String

Definition at line 342 of file OutputPage.php.

OutputPage::getModuleMessages	(	$	filter = `false`,
		$	position = `null`
	)

Get the list of module messages to include on this page.

Parameters:

$filter
$position

Returns:: Array of module names

Definition at line 524 of file OutputPage.php.

Referenced by ParserOutput\addOutputPageMetadata().

OutputPage::getModules	(	$	filter = `false`,
		$	position = `null`,
		$	param = `'mModules'`
	)

Get the list of modules to include on this page.

Parameters:

$filter	Bool whether to filter out insufficiently trustworthy modules
$position	String if not null, only return modules with this position
$param	string

Returns:: Array of module names

Definition at line 452 of file OutputPage.php.

Referenced by ParserOutput\addOutputPageMetadata().

OutputPage::getModuleScripts	(	$	filter = `false`,
		$	position = `null`
	)

Get the list of module JS to include on this page.

Parameters:

$filter
$position

Returns:: array of module names

Definition at line 478 of file OutputPage.php.

Referenced by ParserOutput\addOutputPageMetadata().

OutputPage::getModuleStyles	(	$	filter = `false`,
		$	position = `null`
	)

Get the list of module CSS to include on this page.

Parameters:

$filter
$position

Returns:: Array of module names

Definition at line 501 of file OutputPage.php.

Referenced by ParserOutput\addOutputPageMetadata().

OutputPage::getPageTitle ( )

Return the "page title", i.e.

the content of the <h1> tag.

Returns:: String

Definition at line 839 of file OutputPage.php.

OutputPage::getPageTitleActionText ( )

Get the value of the "action text".

Returns:: String

Definition at line 774 of file OutputPage.php.

OutputPage::getRedirect ( )

Get the URL to redirect to, or an empty string if not redirect URL set.

Returns:: String

Definition at line 279 of file OutputPage.php.

OutputPage::getResourceLoader ( )

Get a ResourceLoader object associated with this OutputPage.

Returns:: ResourceLoader

Definition at line 2500 of file OutputPage.php.

OutputPage::getRevisionId ( )

Get the displayed revision ID.

Returns:: Integer

Definition at line 1347 of file OutputPage.php.

OutputPage::getRevisionTimestamp ( )

Get the timestamp of displayed revision.

This will be null if not filled by setRevisionTimestamp().

Returns:: String or null

Definition at line 1368 of file OutputPage.php.

OutputPage::getScript ( )

Get all registered JS and CSS tags for the header.

Returns:: String

Definition at line 417 of file OutputPage.php.

OutputPage::getScriptsForBottomQueue ( $ inHead )

JS stuff to put at the 'bottom', which can either be the bottom of the "<body>" or the bottom of the "<head>" depending on $wgResourceLoaderExperimentalAsyncLoading: modules marked with position 'bottom', legacy scripts ($this->mScripts), user preferences, site JS and user JS.

Parameters:

$inHead boolean If true, this HTML goes into the "<head>", if false it goes into the "<body>"

Returns:: string

Definition at line 2749 of file OutputPage.php.

static OutputPage::getStatusMessage ( $ code ) [static]

Get the message associed with the HTTP response code $code.

Parameters:

$code Integer: status code

Returns:: String or null: message or null if $code is not in the list of messages

Deprecated:: since 1.18 Use HttpStatus::getMessage() instead.

Definition at line 1903 of file OutputPage.php.

OutputPage::getSubtitle ( )

Get the subtitle.

Returns:: String

Definition at line 911 of file OutputPage.php.

OutputPage::getSyndicationLinks ( )

Return URLs for each supported syndication format for this page.

Returns:: array associating format keys with URLs

Definition at line 1031 of file OutputPage.php.

OutputPage::getTemplateIds ( )

Get the templates used on this page.

Returns:: Array (namespace => dbKey => revId)

Since:: 1.18

Definition at line 1401 of file OutputPage.php.

OutputPage::getVaryHeader ( )

Return a Vary: header on which to vary caches.

Based on the keys of $mVaryHeader, such as Accept-Encoding or Cookie

Returns:: String

Definition at line 1720 of file OutputPage.php.

OutputPage::getXVO ( )

Get a complete X-Vary-Options header.

Returns:: String

Definition at line 1729 of file OutputPage.php.

OutputPage::hasHeadItem ( $ name )

Check if the header item $name is already set.

Parameters:

$name String: item name

Returns:: Boolean

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

Returns:: Boolean

Definition at line 1676 of file OutputPage.php.

OutputPage::headElement	(	Skin $	sk,
		$	includeStyle = `true`
	)

Parameters:

$sk	Skin The given Skin
$includeStyle	Boolean: unused

Returns:: String: The doctype, opening "<html>", and head element.

Definition at line 2390 of file OutputPage.php.

OutputPage::includeJQuery ( $ modules = array() )

Include jQuery core.

Use this to avoid loading it multiple times before we get a usable script loader.

Parameters:

$modules Array: list of jQuery modules which should be loaded

Returns:: Array: the list of modules which were not loaded.

Since:: 1.16

Deprecated:: since 1.17

Definition at line 3587 of file OutputPage.php.

OutputPage::isArticle ( )

Return whether the content displayed page is related to the source of the corresponding article on the wiki.

Returns:: Boolean

Definition at line 1064 of file OutputPage.php.

OutputPage::isArticleRelated ( )

Return whether this page is related an article on the wiki.

Returns:: Boolean

Definition at line 1086 of file OutputPage.php.

OutputPage::isDisabled ( )

Return whether the output will be completely disabled.

Returns:: Boolean

Definition at line 944 of file OutputPage.php.

OutputPage::isPrintable ( )

Return whether the page is "printable".

Returns:: Boolean

Definition at line 928 of file OutputPage.php.

OutputPage::isSyndicated ( )

Should we output feed links for this page?

Returns:: Boolean

Definition at line 1023 of file OutputPage.php.

OutputPage::isUserJsAllowed ( )

Return whether user JavaScript is allowed for this page.

Deprecated:: since 1.18 Load modules with ResourceLoader, and origin and trustworthiness is identified and enforced automagically.

Will be removed in 1.20.

Returns:: Boolean

Definition at line 1229 of file OutputPage.php.

OutputPage::loginToUse ( )

Produce the stock "please login to use the wiki" page.

Deprecated:: in 1.19; throw the exception directly

Definition at line 2167 of file OutputPage.php.

OutputPage::makeResourceLoaderLink	(	$	modules,
		$	only,
		$	useESI = `false`,
		array $	extraQuery = `array()`,
		$	loadCall = `false`
	)		`[protected]`

TODO: Document.

Parameters:

$modules	Array/string with the module name(s)
$only	String ResourceLoaderModule TYPE_ class constant
$useESI	boolean
$extraQuery	Array with extra query parameters to add to each request. array( param => value )
$loadCall	boolean If true, output an (asynchronous) mw.loader.load() call rather than a "<script src='...'>" tag

Returns:: string html "<script>" and "<style>" tags

Definition at line 2516 of file OutputPage.php.

OutputPage::out ( $ ins )

Actually output something with print().

Parameters:

$ins	String: the string to output

Definition at line 2004 of file OutputPage.php.

OutputPage::output ( )

Finally, all the text has been munged and accumulated into the object, let's actually output it:

Definition at line 1912 of file OutputPage.php.

OutputPage::parse	(	$	text,
		$	linestart = `true`,
		$	interface = `false`,
		$	language = `null`
	)

Parse wikitext and return the HTML.

Parameters:

$text	String
$linestart	Boolean: is this the start of a line?
$interface	Boolean: use interface language ($wgLang instead of $wgContLang) while parsing language sensitive magic words like GRAMMAR and PLURAL. This also disables LanguageConverter.
$language	Language object: target language object, will override $interface

Returns:: String: HTML

Definition at line 1577 of file OutputPage.php.

OutputPage::parseInline	(	$	text,
		$	linestart = `true`,
		$	interface = `false`
	)

Parse wikitext, strip paragraphs, and return the HTML.

Parameters:

$text	String
$linestart	Boolean: is this the start of a line?
$interface	Boolean: use interface language ($wgLang instead of $wgContLang) while parsing language sensitive magic words like GRAMMAR and PLURAL

Returns:: String: HTML

Definition at line 1617 of file OutputPage.php.

OutputPage::parserOptions ( $ options = null )

Get/set the ParserOptions object to use for wikitext parsing.

Parameters:

$options ParserOptions|null either the ParserOption to use or null to only get the current ParserOption object

Returns:: ParserOptions object

Definition at line 1322 of file OutputPage.php.

OutputPage::permissionRequired ( $ permission )

Display an error page noting that a given permission bit is required.

Deprecated:: since 1.18, just throw the exception directly

Parameters:

$permission String: key required

Definition at line 2158 of file OutputPage.php.

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

Parameters:

$pageTitle	String\|Message will be passed directly to setPageTitle()
$htmlTitle	String\|Message will be passed directly to setHTMLTitle(); optional, if not passed the "<title>" attribute will be based on $pageTitle

Definition at line 2026 of file OutputPage.php.

OutputPage::prependHTML ( $ text )

Prepend $text to the body HTML.

Parameters:

$text String: HTML

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

Parameters:

$enable bool

Definition at line 1795 of file OutputPage.php.

OutputPage::rateLimited ( )

Turn off regular page output and return an error reponse for when rate limiting has triggered.

Definition at line 2288 of file OutputPage.php.

OutputPage::readOnlyPage	(	$	source = `null`,
		$	protected = `false`,
		$	reasons = `array()`,
		$	action = `null`
	)

Display a page stating that the Wiki is in read-only mode, and optionally show the source of the page that the user was trying to edit.

Should only be called (for this purpose) after wfReadOnly() has returned true.

For historical reasons, this function is _also_ used to show the error message when a user tries to edit a page they are not allowed to edit. (Unless it's because they're blocked, then we show blockedPage() instead.) In this case, the second parameter should be set to true and a list of reasons supplied as the third parameter.

Todo:: Needs to be split into multiple functions.

Parameters:

$source	String: source code to show (or null).
$protected	Boolean: is this a permissions error?
$reasons	Array: list of reasons for this error, as returned by Title::getUserPermissionsErrors().
$action	String: action that was denied or null if unknown

Definition at line 2228 of file OutputPage.php.

OutputPage::redirect	(	$	url,
		$	responsecode = `'302'`
	)

Redirect to $url rather than displaying the normal page.

Parameters:

$url	String: URL
$responsecode	String: HTTP status code

Definition at line 268 of file OutputPage.php.

OutputPage::reduceAllowedModules	(	$	type,
		$	level
	)

As for setAllowedModules(), but don't inadvertantly make the page more accessible.

Parameters:

$type	String
$level	Int ResourceLoaderModule class constant

Definition at line 1264 of file OutputPage.php.

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.

Parameters:

$unused
$returnto	Title or String to return to
$returntoquery	String: query string for the return to link

Definition at line 2360 of file OutputPage.php.

OutputPage::sendCacheControl ( )

Send cache control HTTP headers.

Definition at line 1828 of file OutputPage.php.

OutputPage::setAllowedModules	(	$	type,
		$	level
	)

Set the highest level of CSS/JS untrustworthiness allowed.

Parameters:

$type	String ResourceLoaderModule TYPE_ constant
$level	Int ResourceLoaderModule class constant

Definition at line 1255 of file OutputPage.php.

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

Parameters:

$only Boolean: whether to output only the body of the article

Definition at line 597 of file OutputPage.php.

OutputPage::setArticleFlag ( $ v )

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.

Parameters:

$v Boolean

Definition at line 1051 of file OutputPage.php.

OutputPage::setArticleRelated ( $ v )

Set whether this page is related an article on the wiki Setting false will cause the change of "article flag" toggle to false.

Parameters:

$v Boolean

Definition at line 1074 of file OutputPage.php.

OutputPage::setCategoryLinks ( $ categories )

Reset the category links (but not the category list) and add $categories.

Parameters:

$categories Array mapping category name => sort key

Definition at line 1185 of file OutputPage.php.

OutputPage::setETag ( $ tag )

Set the value of the ETag HTTP header, only used if $wgUseETag is true.

Parameters:

$tag	String: value of "ETag" header

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

See also:: addFeedLink()

Parameters:

$val	String: query to append to feed links or false to output default links

Definition at line 991 of file OutputPage.php.

OutputPage::setFileVersion ( $ file )

Set the displayed file version.

Parameters:

$file File|bool

Returns:: Mixed: previous value

Definition at line 1378 of file OutputPage.php.

OutputPage::setFollowPolicy ( $ policy )

Set the follow policy for the page, but leave the index policy un- touched.

Parameters:

$policy String: either 'follow' or 'nofollow'.

Returns:: null

Definition at line 752 of file OutputPage.php.

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.

Parameters:

$name string

Definition at line 786 of file OutputPage.php.

OutputPage::setIndexPolicy ( $ policy )

Set the index policy for the page, but leave the follow policy un- touched.

Parameters:

$policy string Either 'index' or 'noindex'.

Returns:: null

Definition at line 738 of file OutputPage.php.

OutputPage::setLanguageLinks ( $ newLinkArray )

Reset the language links and add new language links.

Parameters:

$newLinkArray array Associative array mapping language code to the page name

Definition at line 1106 of file OutputPage.php.

OutputPage::setLastModified ( $ timestamp )

Override the last modified timestamp.

Parameters:

$timestamp String: new timestamp, in a format readable by wfTimestamp()

Definition at line 708 of file OutputPage.php.

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.

Parameters:

$name string|Message

Definition at line 820 of file OutputPage.php.

OutputPage::setPageTitleActionText ( $ text )

Set the new value of the "action text", this will be added to the "HTML title", separated from it with " - ".

Parameters:

$text String: new value of the "action text"

Definition at line 765 of file OutputPage.php.

OutputPage::setPrintable ( )

Set the page as printable, i.e.

it'll be displayed with with all print styles included

Definition at line 919 of file OutputPage.php.

OutputPage::setRedirectedFrom ( $ t )

Set $mRedirectedFrom, the Title of the page which redirected us to the current page.

Parameters:

$t Title

Definition at line 808 of file OutputPage.php.

OutputPage::setRevisionId ( $ revid )

Set the revision ID which will be seen by the wiki text parser for things such as embedded {{REVISIONID}} variable use.

Parameters:

$revid Mixed: an positive integer, or null

Returns:: Mixed: previous value

Definition at line 1337 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().

Parameters:

$timestamp Mixed: string, or null

Returns:: Mixed: previous value

Definition at line 1358 of file OutputPage.php.

OutputPage::setRobotPolicy ( $ policy )

Set the robot policy for the page: <http://www.robotstxt.org/meta.html>

Parameters:

$policy String: the literal string to output as the contents of the meta tag. Will be parsed according to the spec and output in standardized form.

Returns:: null

Definition at line 720 of file OutputPage.php.

OutputPage::setSquidMaxage ( $ maxage )

Set the value of the "s-maxage" part of the "Cache-control" HTTP header.

Parameters:

$maxage Integer: maximum cache time on the Squid, in seconds.

Definition at line 1633 of file OutputPage.php.

OutputPage::setStatusCode ( $ statusCode )

Set the HTTP status code to send with the output.

Parameters:

$statusCode Integer

Definition at line 288 of file OutputPage.php.

OutputPage::setSubtitle ( $ str )

Replace the subtile with $str.

Parameters:

$str	String\|Message: new value of the subtitle

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

See also:: addFeedLink()

Parameters:

$show Boolean: true: add default feeds, false: remove all feeds

Definition at line 974 of file OutputPage.php.

OutputPage::setTitle ( Title $ t )

Set the Title object to use.

Parameters:

$t	Title object

Definition at line 848 of file OutputPage.php.

OutputPage::showErrorPage	(	$	title,
		$	msg,
		$	params = `array()`
	)

Output a standard error page.

showErrorPage( 'titlemsg', 'pagetextmsg', array( 'param1', 'param2' ) ); showErrorPage( 'titlemsg', $messageObject ); showErrorPage( $titleMessageObj, $messageObject );

Parameters:

$title	Mixed: message key (string) for page title, or a Message object
$msg	Mixed: message key (string) for page text, or a Message object
$params	Array: message parameters; ignored if $msg is a Message object

Definition at line 2050 of file OutputPage.php.

OutputPage::showFatalError ( $ message )

Definition at line 2312 of file OutputPage.php.

OutputPage::showFileCopyError	(	$	old,
		$	new
	)

Definition at line 2322 of file OutputPage.php.

OutputPage::showFileDeleteError ( $ name )

Definition at line 2330 of file OutputPage.php.

OutputPage::showFileNotFoundError ( $ name )

Definition at line 2334 of file OutputPage.php.

OutputPage::showFileRenameError	(	$	old,
		$	new
	)

Definition at line 2326 of file OutputPage.php.

OutputPage::showLagWarning ( $ lag )

Show a warning about slave lag.

If the lag is higher than $wgSlaveLagCritical seconds, then the warning is a bit more obvious. If the lag is lower than $wgSlaveLagWarning, then no warning is shown.

Parameters:

$lag	Integer: slave lag

Definition at line 2301 of file OutputPage.php.

OutputPage::showNewSectionLink ( )

Show an "add new section" link?

Returns:: Boolean

Definition at line 953 of file OutputPage.php.

OutputPage::showPermissionsErrorPage	(	$	errors,
		$	action = `null`
	)

Output a standard permission error page.

Parameters:

$errors	Array: error message keys
$action	String: action that was denied or null if unknown

Definition at line 2072 of file OutputPage.php.

OutputPage::showUnexpectedValueError	(	$	name,
		$	val
	)

Definition at line 2318 of file OutputPage.php.

OutputPage::styleLink	(	$	style,
		$	options
	)		`[protected]`

Generate <link> tags for stylesheets.

Parameters:

$style	String: URL to the file
$options	Array: option, can contain 'condition', 'dir', 'media' keys

Returns:: String: HTML fragment

Definition at line 3432 of file OutputPage.php.

static OutputPage::transformCssMedia ( $ media ) [static]

Transform "media" attribute based on request parameters.

Parameters:

$media String: current value of the "media" attribute

Returns:: String: modified value of the "media" attribute

Definition at line 3472 of file OutputPage.php.

Referenced by ResourceLoader\makeCombinedStyles().

OutputPage::userCanPreview ( )

To make it harder for someone to slip a user a fake user-JavaScript or user-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.

Returns:: bool

Definition at line 2997 of file OutputPage.php.

OutputPage::versionRequired ( $ version )

Display an error page indicating that a given version of MediaWiki is required to use it.

Parameters:

$version Mixed: the version of MediaWiki needed to use the page

Definition at line 2146 of file OutputPage.php.

OutputPage::wrapWikiMsg ( $ wrap )

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 either be strings, in which case they are the message names, or arrays, in which case 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 users interface language.

For example:

$wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>", 'some-error' );

Is equivalent to:

$wgOut->addWikiText( "<div class='error'>\n" . wfMessage( 'some-error' )->plain() . "\n</div>" );

The newline after opening div is needed in some wikitext. See bug 19226.

Parameters:

$wrap string

Definition at line 3552 of file OutputPage.php.

Member Data Documentation

OutputPage::$mAllowedModules [protected]

Initial value:

 array(
                ResourceLoaderModule::TYPE_COMBINED => ResourceLoaderModule::ORIGIN_ALL,
        )

Definition at line 159 of file OutputPage.php.

OutputPage::$mArticleBodyOnly = false

Flag if output should only contain the body of the article.

Should be private.

Definition at line 192 of file OutputPage.php.

OutputPage::$mBodytext = ''

Contains all of the "<body>" content. Should be private we got set/get accessors and the append() method.

Definition at line 54 of file OutputPage.php.

OutputPage::$mCategories = array()

Definition at line 111 of file OutputPage.php.

OutputPage::$mCategoryLinks = array()

Definition at line 110 of file OutputPage.php.

OutputPage::$mContainsNewMagic = 0

Definition at line 170 of file OutputPage.php.

OutputPage::$mContainsOldMagic = 0

Definition at line 170 of file OutputPage.php.

OutputPage::$mDebugtext = ''

Holds the debug lines that will be output as comments in page source if $wgDebugComments is enabled.

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation