Class for viewing MediaWiki article and history. More...

Inheritance diagram for Article:

[legend]

Collaboration diagram for Article:

[legend]

Public Member Functions
	__construct (Title $title, $oldId=null)

	__get ( $fname)

	__set ( $fname, $fvalue)

	addHelpLink ( $to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators. More...

	adjustDisplayTitle (ParserOutput $pOutput)
	Adjust title for pages with displaytitle, -{T\|}- or language conversion. More...

	clear ()

	doDelete ( $reason, $suppress=false, $immediate=false)
	Perform a deletion and output success or failure messages. More...

	fetchRevisionRecord ()
	Fetches the revision to work on. More...

	getActionOverrides ()
	Call to WikiPage function for backwards compatibility. More...

	getContext ()
	Gets the context this Article is executed in. More...

	getOldID ()

	getOldIDFromRequest ()
	Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect. More...

	getPage ()
	Get the WikiPage object of this instance. More...

	getParserOptions ()
	Get parser options suitable for rendering the primary article wikitext. More...

	getParserOutput ( $oldid=null, UserIdentity $user=null)
	#- More...

	getRedirectedFrom ()
	Get the page this view was redirected from. More...

	getRevIdFetched ()
	Use this to fetch the rev ID used on page views. More...

	getRobotPolicy ( $action, ParserOutput $pOutput=null)
	Get the robot policy to be used for the current view. More...

	getTimestamp ()

	getTitle ()
	Get the title object of the article. More...

	isCurrent ()
	Returns true if the currently-referenced revision is the current edit to this page (and it exists). More...

	isFileCacheable ( $mode=HTMLFileCache::MODE_NORMAL)
	Check if the page can be cached. More...

	protect ()
	action=protect handler More...

	render ()
	Handle action=render. More...

	setContext ( $context)
	Sets the context this Article is executed in. More...

	setOldSubtitle ( $oldid=0)
	Generate the navigation links when browsing through an article revisions It shows the information as: Revision as of \<date\>; view current revision \<- Previous version \| Next Version -\> More...

	setRedirectedFrom (Title $from)
	Tell the page view functions that this view was redirected from another page on the wiki. More...

	showDeletedRevisionHeader ()
	If the revision requested for view is deleted, check permissions. More...

	showMissingArticle ()
	Show the error text for a missing article. More...

	showNamespaceHeader ()
	Show a header specific to the namespace currently being viewed, like [[MediaWiki:Talkpagetext]]. More...

	showPatrolFooter ()
	If patrol is possible, output a patrol UI box. More...

	showRedirectedFromHeader ()
	If this request is a redirect view, send "redirected from" subtitle to the output. More...

	showViewFooter ()
	Show the footer section of an ordinary page view. More...

	unprotect ()
	action=unprotect handler (alias) More...

	view ()
	This is the default action of the index.php entry point: just view the page of the given title. More...

	viewRedirect ( $target, $appendSubtitle=true, $forceKnown=false)
	Return the HTML for the top of a redirect page. More...

Static Public Member Functions
static	formatRobotPolicy ( $policy)
	Converts a String robot policy into an associative array, to allow merging of several policies using array_merge(). More...

static	getRedirectHeaderHtml (Language $lang, $target, $forceKnown=false)
	Return the HTML for the top of a redirect page. More...

static	newFromID ( $id)
	Constructor from a page id. More...

static	newFromTitle ( $title, IContextSource $context)
	Create an Article object of the appropriate class for the given page. More...

static	newFromWikiPage (WikiPage $page, IContextSource $context)
	Create an Article object of the appropriate class for the given page. More...

static	purgePatrolFooterCache ( $articleID)
	Purge the cache used to check if it is worth showing the patrol footer For example, it is done during re-uploads when file patrol is used. More...

Public Attributes
int null	$mOldId
	The oldid of the article that was requested to be shown, 0 for the current revision. More...

ParserOutput null false	$mParserOutput = null
	The ParserOutput generated for viewing the page, initialized by view(). More...

Title null	$mRedirectedFrom = null
	Title from which we were redirected here, if any. More...

string bool	$mRedirectUrl = false
	URL to redirect to or false if none. More...

Protected Member Functions
	newPage (Title $title)

	showDiffPage ()
	Show a diff page according to current request variables. More...

	tryFileCache ()
	checkLastModified returns true if it has taken care of all output to the client that is necessary for this request. More...

Protected Attributes
LinkRenderer	$linkRenderer

IContextSource null	$mContext
	The context this Article is executed in. More...

WikiPage	$mPage
	The WikiPage object of this instance. More...

bool	$viewIsRenderAction = false
	Whether render() was called. More...

Private Member Functions
	doOutputFromParserCache (ParserOutput $pOutput, OutputPage $outputPage, array $textOptions)

	doOutputFromRenderStatus (?RevisionRecord $rev, Status $renderStatus, OutputPage $outputPage, array $textOptions)

	doOutputMetaData (?ParserOutput $pOutput, OutputPage $outputPage)

	generateContentOutput (Authority $performer, ParserOptions $parserOptions, int $oldid, OutputPage $outputPage, array $textOptions)
	Determines the desired ParserOutput and passes it to $outputPage. More...

	getRevisionRedirectTarget (RevisionRecord $revision)

	showViewError (string $errortext)
	Show error text for errors generated in Article::view(). More...

Private Attributes
Status null	$fetchResult = null
	represents the outcome of fetchRevisionRecord(). More...

RevisionRecord null	$mRevisionRecord = null
	Revision to be shown. More...

RevisionStore	$revisionStore

UserNameUtils	$userNameUtils

WatchlistManager	$watchlistManager

Detailed Description

Class for viewing MediaWiki article and history.

This maintains WikiPage functions for backwards compatibility.

Todo:: Move and rewrite code to an Action class

Note: edit user interface and cache support functions have been moved to separate EditPage and HTMLFileCache classes.

Definition at line 49 of file Article.php.

Constructor & Destructor Documentation

◆ __construct()

Article::__construct	(	Title	$title,
			$oldId = `null`
	)

Parameters

Title	$title
int \| null	$oldId	Revision ID, null to fetch from request, zero for current

Definition at line 127 of file Article.php.

References newPage().

Member Function Documentation

◆ __get()

Article::__get ( $fname )

Deprecated:: since 1.35, use Article::getPage() instead

Use PHP's magic __get handler to handle accessing of raw WikiPage fields for backwards compatibility

Parameters

string $fname Field name

Returns: mixed

Definition at line 1996 of file Article.php.

References wfDeprecatedMsg().

◆ __set()

Article::__set	(	$fname,
		$fvalue
	)

Deprecated:: since 1.35, use Article::getPage() instead

Use PHP's magic __set handler to handle setting of raw WikiPage fields for backwards compatibility

Parameters

string	$fname	Field name
mixed	$fvalue	New value

Definition at line 2015 of file Article.php.

References wfDeprecatedMsg().

◆ addHelpLink()

Article::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: 'namespace-' + namespace number + '-helppage'.

Parameters

string	$to	Target MediaWiki.org page title or encoded URL.
bool	$overrideBaseUrl	Whether $url is a full URL, to avoid MW.o.

Since: 1.25

Definition at line 1773 of file Article.php.

References $title, getContext(), getTitle(), and Title\newFromText().

Referenced by CategoryPage\closeShowCategory().

◆ adjustDisplayTitle()

Article::adjustDisplayTitle ( ParserOutput $pOutput )

Adjust title for pages with displaytitle, -{T|}- or language conversion.

Parameters

ParserOutput $pOutput

Definition at line 829 of file Article.php.

References getContext(), and ParserOutput\getTitleText().

Referenced by doOutputMetaData().

◆ clear()

Article::clear ( )

Definition at line 238 of file Article.php.

◆ doDelete()

Article::doDelete	(	$reason,
		$suppress = `false`,
		$immediate = `false`
	)

Perform a deletion and output success or failure messages.

Deprecated:: since 1.37 Use WikiPage::doDeleteArticleReal if you only need to delete the article. If you also need things to happen with OutputPage, you may want to check the hooks in DeleteAction instead.

Parameters

string	$reason
bool	$suppress
bool	$immediate	false allows deleting over time via the job queue

Exceptions

FatalError
MWException

Definition at line 1825 of file Article.php.

References Xml\element(), getContext(), getTitle(), LogEventsList\showLogExtract(), wfEscapeWikiText(), and wfMessage().

◆ doOutputFromParserCache()

Article::doOutputFromParserCache	(	ParserOutput	$pOutput,
		OutputPage	$outputPage,
		array	$textOptions
	)

private

Parameters

ParserOutput	$pOutput
OutputPage	$outputPage
array	$textOptions

Definition at line 747 of file Article.php.

References OutputPage\addParserOutput(), CacheTime\getCacheRevisionId(), ParserOutput\getSections(), ParserOutput\getTimestamp(), OutputPage\setRevisionId(), OutputPage\setRevisionTimestamp(), and OutputPage\setSections().

Referenced by generateContentOutput().

◆ doOutputFromRenderStatus()

Article::doOutputFromRenderStatus	(	?RevisionRecord	$rev,
		Status	$renderStatus,
		OutputPage	$outputPage,
		array	$textOptions
	)

private

Parameters

RevisionRecord \| null	$rev
Status	$renderStatus
OutputPage	$outputPage
array	$textOptions

Definition at line 774 of file Article.php.

References OutputPage\addHTML(), OutputPage\addParserOutput(), OutputPage\addSubtitle(), getContext(), getRevisionRedirectTarget(), StatusValue\getValue(), Status\getWikiText(), StatusValue\hasMessage(), StatusValue\isOK(), OutputPage\setCdnMaxage(), OutputPage\setLastModified(), and showViewError().

Referenced by generateContentOutput().

◆ doOutputMetaData()

Article::doOutputMetaData	(	?ParserOutput	$pOutput,
		OutputPage	$outputPage
	)

private

Parameters

	?ParserOutput	$pOutput
OutputPage	$outputPage

Definition at line 728 of file Article.php.

References adjustDisplayTitle(), getRobotPolicy(), OutputPage\setFollowPolicy(), and OutputPage\setIndexPolicy().

Referenced by generateContentOutput().

◆ fetchRevisionRecord()

Article::fetchRevisionRecord ( )

Fetches the revision to work on.

The revision is loaded from the database. Refer to $this->fetchResult for the revision or any errors encountered while loading it.

Public since 1.35

Returns: RevisionRecord|null

Definition at line 338 of file Article.php.

References $mRevisionRecord, $title, getOldID(), getTitle(), StatusValue\newFatal(), StatusValue\newGood(), and wfDebug().

Referenced by generateContentOutput(), and showDiffPage().

◆ formatRobotPolicy()

static Article::formatRobotPolicy ( $policy )

static

Converts a String robot policy into an associative array, to allow merging of several policies using array_merge().

Parameters

array | string $policy Returns empty array on null/false/'', transparent to already-converted arrays, converts string.

Returns: array 'index' => \<indexpolicy\>, 'follow' => \<followpolicy\>

Definition at line 990 of file Article.php.

Referenced by getRobotPolicy(), and OutputPage\setRobotPolicy().

◆ generateContentOutput()

Article::generateContentOutput	(	Authority	$performer,
		ParserOptions	$parserOptions,
		int	$oldid,
		OutputPage	$outputPage,
		array	$textOptions
	)

private

Determines the desired ParserOutput and passes it to $outputPage.

Parameters

Authority	$performer
ParserOptions	$parserOptions
int	$oldid
OutputPage	$outputPage
array	$textOptions

Returns: bool True if further processing like footer generation should be applied, false to skip further processing.

Definition at line 566 of file Article.php.

References $lang, OutputPage\addModuleStyles(), doOutputFromParserCache(), doOutputFromRenderStatus(), doOutputMetaData(), fetchRevisionRecord(), getContext(), getPage(), getRevIdFetched(), getTitle(), setOldSubtitle(), OutputPage\setRevisionId(), OutputPage\setRevisionTimestamp(), showDeletedRevisionHeader(), showMissingArticle(), showViewError(), wfDebug(), and OutputPage\wrapWikiMsg().

Referenced by view().

◆ getActionOverrides()

Article::getActionOverrides ( )

Call to WikiPage function for backwards compatibility.

See also: ContentHandler::getActionOverrides

Returns: array

Definition at line 2034 of file Article.php.

Referenced by MediaWiki\Actions\ActionFactory\getAction().

◆ getContext()

Article::getContext ( )

Gets the context this Article is executed in.

Returns: IContextSource

Since: 1.18

Definition at line 1977 of file Article.php.

References $mContext, RequestContext\getMain(), and wfDebug().

Referenced by ImageHistoryList\__construct(), EditPage\__construct(), ProtectionForm\__construct(), addHelpLink(), adjustDisplayTitle(), CategoryPage\closeShowCategory(), ImagePage\createXmlOptionStringForLanguage(), doDelete(), doOutputFromRenderStatus(), ImagePage\doRenderLangOpt(), Action\factory(), generateContentOutput(), getOldIDFromRequest(), getParserOptions(), getRobotPolicy(), ImagePage\getThumbPrevText(), ImagePage\getThumbSizes(), ImagePage\imageDupes(), ImagePage\imageHistory(), ImagePage\imageLinks(), isFileCacheable(), ImagePage\makeMetadataTable(), ImagePage\openShowImage(), ImagePage\printSharedImageText(), render(), setOldSubtitle(), showDeletedRevisionHeader(), showDiffPage(), ImagePage\showError(), showMissingArticle(), showNamespaceHeader(), showPatrolFooter(), showRedirectedFromHeader(), ImagePage\showTOC(), showViewError(), showViewFooter(), tryFileCache(), ImagePage\uploadLinksBox(), view(), CategoryPage\view(), ImagePage\view(), and viewRedirect().

◆ getOldID()

Article::getOldID ( )

See also: getOldIDFromRequest(); getRevIdFetched()

Returns: int The oldid of the article that is was requested in the constructor or via the context's WebRequest.

Definition at line 256 of file Article.php.

References $mOldId, and getOldIDFromRequest().

Referenced by fetchRevisionRecord(), isCurrent(), showDeletedRevisionHeader(), showDiffPage(), showMissingArticle(), view(), and ImagePage\view().

◆ getOldIDFromRequest()

Article::getOldIDFromRequest ( )

Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect.

Returns: int The old id for the request

Definition at line 269 of file Article.php.

References $mRevisionRecord, getContext(), MediaWiki\Revision\RevisionRecord\getId(), and getTitle().

Referenced by getOldID().

◆ getPage()

Article::getPage ( )

Get the WikiPage object of this instance.

Since: 1.19

Returns: WikiPage

Definition at line 234 of file Article.php.

References $mPage.

Referenced by ImageHistoryList\__construct(), EditPage\__construct(), CategoryPage\closeShowCategory(), generateContentOutput(), ImagePage\getDuplicates(), ImagePage\getFile(), ImagePage\getForeignCategories(), ImagePage\imageDupes(), ImagePage\isLocal(), ImagePage\loadFile(), ImagePage\openShowImage(), ImagePage\printSharedImageText(), ImagePage\setFile(), DeleteAction\tempDelete(), CategoryPage\view(), and ImagePage\view().

◆ getParserOptions()

Article::getParserOptions ( )

Get parser options suitable for rendering the primary article wikitext.

Returns: ParserOptions

Definition at line 1957 of file Article.php.

References getContext().

Referenced by getParserOutput(), and view().

◆ getParserOutput()

Article::getParserOutput	(		$oldid = `null`,
		UserIdentity	$user = `null`
	)

#-

Lightweight method to get the parser output for a page, checking the parser cache and so on. Doesn't consider most of the stuff that Article::view() is forced to consider, so it's not appropriate to use there.

Since: 1.16 (r52326) for LiquidThreads

Parameters

int \| null	$oldid	Revision ID or null
UserIdentity \| null	$user	The relevant user

Returns: ParserOutput|bool ParserOutput or false if the given revision ID is not found

Definition at line 1943 of file Article.php.

References getParserOptions().

◆ getRedirectedFrom()

Article::getRedirectedFrom ( )

Get the page this view was redirected from.

Returns: Title|null

Since: 1.28

Definition at line 206 of file Article.php.

References $mRedirectedFrom.

◆ getRedirectHeaderHtml()

static Article::getRedirectHeaderHtml	(	Language	$lang,
			$target,
			$forceKnown = `false`
	)

static

Return the HTML for the top of a redirect page.

Chances are you should just be using the ParserOutput from WikitextContent::getParserOutput instead of calling this for redirects.

Since: 1.23

Parameters

Language	$lang
Title \| Title[]	$target	Destination(s) to redirect
bool	$forceKnown	Should the image be shown as a bluelink regardless of existence?

Returns: string Containing HTML with redirect link

Definition at line 1726 of file Article.php.

References $lang, $linkRenderer, $title, MediaWiki\Linker\LinkRenderer\makeKnownLink(), MediaWiki\Linker\LinkRenderer\makeLink(), and wfMessage().

Referenced by WikitextContentHandler\fillParserOutput().

◆ getRevIdFetched()

Article::getRevIdFetched ( )

Use this to fetch the rev ID used on page views.

Before fetchRevisionRecord was called, this returns the page's latest revision, regardless of what getOldID() returns.

Returns: int Revision ID of last article revision

Definition at line 415 of file Article.php.

Referenced by generateContentOutput(), and view().

◆ getRevisionRedirectTarget()

Article::getRevisionRedirectTarget ( RevisionRecord $revision )

private

Parameters

RevisionRecord $revision

Returns: null|Title

Definition at line 817 of file Article.php.

References $content, and MediaWiki\Revision\RevisionRecord\getContent().

Referenced by doOutputFromRenderStatus().

◆ getRobotPolicy()

Article::getRobotPolicy	(		$action,
		ParserOutput	$pOutput = `null`
	)

Get the robot policy to be used for the current view.

Parameters

string	$action	The action= GET parameter
ParserOutput \| null	$pOutput

Returns: string[] The policy that should be set

Todo:: actions other than 'view'

Definition at line 908 of file Article.php.

References formatRobotPolicy(), getContext(), getTitle(), NS_USER, and NS_USER_TALK.

Referenced by doOutputMetaData(), and showMissingArticle().

◆ getTimestamp()

Article::getTimestamp ( )

Deprecated:: since 1.35, use WikiPage::getTimestamp instead

See also: WikiPage::getTimestamp

Returns: string

Definition at line 2043 of file Article.php.

References wfDeprecated().

◆ getTitle()

Article::getTitle ( )

Get the title object of the article.

Returns: Title Title object of this page

Definition at line 224 of file Article.php.

Referenced by ImageHistoryList\__construct(), EditPage\__construct(), ProtectionForm\__construct(), addHelpLink(), doDelete(), ImagePage\doRenderLangOpt(), fetchRevisionRecord(), generateContentOutput(), getOldIDFromRequest(), getRobotPolicy(), ImagePage\imageDupes(), ImagePage\imageLinks(), isFileCacheable(), ImagePage\loadFile(), ImagePage\openShowImage(), setOldSubtitle(), showDeletedRevisionHeader(), showMissingArticle(), showNamespaceHeader(), showPatrolFooter(), showRedirectedFromHeader(), showViewFooter(), tryFileCache(), ImagePage\uploadLinksBox(), view(), CategoryPage\view(), ImagePage\view(), and viewRedirect().

◆ isCurrent()

Article::isCurrent ( )

Returns true if the currently-referenced revision is the current edit to this page (and it exists).

Returns: bool

Definition at line 396 of file Article.php.

References getOldID().

Referenced by view().

◆ isFileCacheable()

Article::isFileCacheable ( $mode = HTMLFileCache::MODE_NORMAL )

Check if the page can be cached.

Parameters

int $mode One of the HTMLFileCache::MODE_* constants (since 1.28)

Returns: bool

Definition at line 1915 of file Article.php.

References getContext(), getTitle(), and HTMLFileCache\useFileCache().

Referenced by tryFileCache().

◆ newFromID()

static Article::newFromID ( $id )

static

Constructor from a page id.

Parameters

int $id Article ID to load

Returns: Article|null

Definition at line 151 of file Article.php.

References $t, and Title\newFromID().

◆ newFromTitle()

static Article::newFromTitle	(		$title,
		IContextSource	$context
	)

static

Create an Article object of the appropriate class for the given page.

Parameters

Title	$title
IContextSource	$context

Returns: Article

Definition at line 163 of file Article.php.

References $title, Title\makeTitle(), NS_CATEGORY, NS_FILE, NS_MEDIA, and Hooks\runner().

Referenced by MediaWiki\Permissions\PermissionManager\checkUserBlock(), RebuildFileCache\execute(), and newFromWikiPage().

◆ newFromWikiPage()

static Article::newFromWikiPage	(	WikiPage	$page,
		IContextSource	$context
	)

static

Create an Article object of the appropriate class for the given page.

Parameters

WikiPage	$page
IContextSource	$context

Returns: Article

Definition at line 195 of file Article.php.

References WikiPage\getTitle(), and newFromTitle().

Referenced by Action\convertPageToArticle(), ApiEditPage\execute(), MediaWiki\Actions\ActionFactory\getArticle(), Skin\getFooterLinks(), and MediaWiki\initializeArticle().

◆ newPage()

Article::newPage ( Title $title )

protected

Parameters

Title $title

Returns: WikiPage

Reimplemented in ImagePage, and CategoryPage.

Definition at line 142 of file Article.php.

References $title.

Referenced by __construct().

◆ protect()

Article::protect ( )

action=protect handler

Definition at line 1801 of file Article.php.

Referenced by unprotect().

◆ purgePatrolFooterCache()

static Article::purgePatrolFooterCache ( $articleID )

static

Purge the cache used to check if it is worth showing the patrol footer For example, it is done during re-uploads when file patrol is used.

Parameters

int $articleID ID of the article to purge

Since: 1.27

Definition at line 1301 of file Article.php.

References $cache.

Referenced by LocalFile\recordUpload3().

◆ render()

Article::render ( )

Handle action=render.

Definition at line 1790 of file Article.php.

References getContext(), and view().

◆ setContext()

Article::setContext ( $context )

Sets the context this Article is executed in.

Parameters

IContextSource $context

Since: 1.18

Definition at line 1967 of file Article.php.

◆ setOldSubtitle()

Article::setOldSubtitle ( $oldid = 0 )

Generate the navigation links when browsing through an article revisions It shows the information as: Revision as of \<date\>; view current revision \<- Previous version | Next Version -\>

Parameters

int $oldid Revision ID of this article revision

Definition at line 1548 of file Article.php.

References $mRevisionRecord, getContext(), Linker\getRevDeleteLink(), MediaWiki\Revision\RevisionRecord\getTimestamp(), getTitle(), Linker\revComment(), and Linker\revUserTools().

Referenced by generateContentOutput().

◆ setRedirectedFrom()

Article::setRedirectedFrom ( Title $from )

Tell the page view functions that this view was redirected from another page on the wiki.

Parameters

Title $from

Definition at line 215 of file Article.php.

◆ showDeletedRevisionHeader()

Article::showDeletedRevisionHeader ( )

If the revision requested for view is deleted, check permissions.

Send either an error message or a warning header to the output.

Returns: bool True if the view is allowed, false if not.

Definition at line 1487 of file Article.php.

References getContext(), getOldID(), getTitle(), and Html\warningBox().

Referenced by generateContentOutput().

◆ showDiffPage()

Article::showDiffPage ( )

protected

Show a diff page according to current request variables.

For use within Article::view() only, other callers should use the DifferenceEngine class.

Definition at line 844 of file Article.php.

References fetchRevisionRecord(), getContext(), getOldID(), and wfMessage().

Referenced by view().

◆ showMissingArticle()

Article::showMissingArticle ( )

Show the error text for a missing article.

For articles in the MediaWiki namespace, show the default message text. To be called from Article::view().

Definition at line 1310 of file Article.php.

References $dbr, $lang, $title, DB_REPLICA, getAuthority(), getContext(), getOldID(), getRobotPolicy(), getTitle(), User\newFromName(), NS_MEDIAWIKI, NS_USER, NS_USER_TALK, Xml\openElement(), LogEventsList\showLogExtract(), wfEscapeWikiText(), wfGetDB(), and wfMessage().

Referenced by generateContentOutput().

◆ showNamespaceHeader()

Article::showNamespaceHeader ( )

Show a header specific to the namespace currently being viewed, like [[MediaWiki:Talkpagetext]].

For Article::view().

Definition at line 1093 of file Article.php.

References getContext(), getTitle(), and wfMessage().

Referenced by view().

◆ showPatrolFooter()

Article::showPatrolFooter ( )

If patrol is possible, output a patrol UI box.

This is called from the footer section of ordinary page views. If patrol is not possible or not desired, does nothing.

Side effect: When the patrol link is build, this method will call OutputPage::setPreventClickjacking(true) and load a JS module.

Returns: bool

Definition at line 1129 of file Article.php.

References $cache, $dbr, $title, DB_REPLICA, getAuthority(), getContext(), getTitle(), RecentChange\isInRCLifespan(), RecentChange\newFromConds(), NS_FILE, RC_LOG, wfGetDB(), and wfMessage().

Referenced by showViewFooter().

◆ showRedirectedFromHeader()

Article::showRedirectedFromHeader ( )

If this request is a redirect view, send "redirected from" subtitle to the output.

Returns true if the header was needed, false if this is not a redirect view. Handles both local and remote redirects.

Returns: bool

Definition at line 1019 of file Article.php.

References getContext(), getTitle(), and Linker\makeExternalLink().

Referenced by view().

◆ showViewError()

Article::showViewError ( string $errortext )

private

Show error text for errors generated in Article::view().

Parameters

string $errortext localized wikitext error message

Definition at line 1472 of file Article.php.

References getContext().

Referenced by doOutputFromRenderStatus(), and generateContentOutput().

◆ showViewFooter()

Article::showViewFooter ( )

Show the footer section of an ordinary page view.

Definition at line 1105 of file Article.php.

References getContext(), getTitle(), NS_USER_TALK, and showPatrolFooter().

Referenced by view().

◆ tryFileCache()

Article::tryFileCache ( )

protected

checkLastModified returns true if it has taken care of all output to the client that is necessary for this request.

(that is, it has sent a cached version of the page)

Returns: bool True if cached version send, false otherwise

Definition at line 1884 of file Article.php.

References $cache, getContext(), getTitle(), isFileCacheable(), and wfDebug().

Referenced by view().

◆ unprotect()

Article::unprotect ( )

action=unprotect handler (alias)

Definition at line 1809 of file Article.php.

References protect().

◆ view()

Article::view ( )

This is the default action of the index.php entry point: just view the page of the given title.

Reimplemented in ImagePage, and CategoryPage.

Definition at line 427 of file Article.php.

References generateContentOutput(), getAuthority(), getContext(), getOldID(), getParserOptions(), getRevIdFetched(), getTitle(), isCurrent(), EditPage\POST_EDIT_COOKIE_KEY_PREFIX, Hooks\runner(), showDiffPage(), showNamespaceHeader(), showRedirectedFromHeader(), showViewFooter(), true, tryFileCache(), Html\warningBox(), wfDebug(), and wfMessage().

Referenced by render().

◆ viewRedirect()

Article::viewRedirect	(	$target,
		$appendSubtitle = `true`,
		$forceKnown = `false`
	)

Return the HTML for the top of a redirect page.

Chances are you should just be using the ParserOutput from WikitextContent::getParserOutput instead of calling this for redirects.

Parameters

Title \| array	$target	Destination(s) to redirect
bool	$appendSubtitle	[optional]
bool	$forceKnown	Should the image be shown as a bluelink regardless of existence?

Returns: string Containing HTML with redirect link

Deprecated:: since 1.30

Definition at line 1704 of file Article.php.

References $lang, getContext(), getTitle(), and wfMessage().

Member Data Documentation

◆ $fetchResult

Status null Article::$fetchResult = null

private

represents the outcome of fetchRevisionRecord().

$fetchResult->value is the RevisionRecord object, if the operation was successful.

Definition at line 79 of file Article.php.

◆ $linkRenderer

LinkRenderer Article::$linkRenderer

protected

Definition at line 98 of file Article.php.

Referenced by getRedirectHeaderHtml(), ImagePage\imageDupes(), ImagePage\imageLinks(), and ImagePage\openShowImage().

◆ $mContext

IContextSource null Article::$mContext

protected

The context this Article is executed in.

If null, RequestContext::getMain() is used.

Deprecated:: since 1.35, must be private, use getContext

Definition at line 58 of file Article.php.

Referenced by getContext().

◆ $mOldId

int null Article::$mOldId

The oldid of the article that was requested to be shown, 0 for the current revision.

Definition at line 67 of file Article.php.

Referenced by getOldID().

◆ $mPage

WikiPage Article::$mPage

protected

The WikiPage object of this instance.

Definition at line 61 of file Article.php.

Referenced by getPage().

◆ $mParserOutput

ParserOutput null false Article::$mParserOutput = null

The ParserOutput generated for viewing the page, initialized by view().

If no ParserOutput could be generated, this is set to false.

Deprecated:: since 1.32

Definition at line 86 of file Article.php.

◆ $mRedirectedFrom

Title null Article::$mRedirectedFrom = null

Title from which we were redirected here, if any.

Definition at line 70 of file Article.php.

Referenced by getRedirectedFrom().

◆ $mRedirectUrl

string bool Article::$mRedirectUrl = false

URL to redirect to or false if none.

Definition at line 73 of file Article.php.

◆ $mRevisionRecord

RevisionRecord null Article::$mRevisionRecord = null

private

Revision to be shown.

Initialized by getOldIDFromRequest() or fetchRevisionRecord(). While the output of Article::view is typically based on this revision, it may be replaced by extensions.

Definition at line 121 of file Article.php.

Referenced by fetchRevisionRecord(), getOldIDFromRequest(), and setOldSubtitle().

◆ $revisionStore

RevisionStore Article::$revisionStore

private

Definition at line 103 of file Article.php.

◆ $userNameUtils

UserNameUtils Article::$userNameUtils

private

Definition at line 113 of file Article.php.

◆ $viewIsRenderAction

bool Article::$viewIsRenderAction = false

protected

Whether render() was called.

With the way subclasses work here, there doesn't seem to be any other way to stop calling OutputPage::enableSectionEditLinks() and still have it work as it did before.

Definition at line 93 of file Article.php.

◆ $watchlistManager

WatchlistManager Article::$watchlistManager

private

Definition at line 108 of file Article.php.

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

includes/page/Article.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __get()

◆ __set()

◆ addHelpLink()

◆ adjustDisplayTitle()

◆ clear()

◆ doDelete()

◆ doOutputFromParserCache()

◆ doOutputFromRenderStatus()

◆ doOutputMetaData()

◆ fetchRevisionRecord()

◆ formatRobotPolicy()

◆ generateContentOutput()

◆ getActionOverrides()

◆ getContext()

◆ getOldID()

◆ getOldIDFromRequest()

◆ getPage()

◆ getParserOptions()

◆ getParserOutput()

◆ getRedirectedFrom()

◆ getRedirectHeaderHtml()

◆ getRevIdFetched()

◆ getRevisionRedirectTarget()

◆ getRobotPolicy()

◆ getTimestamp()

◆ getTitle()

◆ isCurrent()

◆ isFileCacheable()

◆ newFromID()

◆ newFromTitle()

◆ newFromWikiPage()

◆ newPage()

◆ protect()

◆ purgePatrolFooterCache()

◆ render()

◆ setContext()

◆ setOldSubtitle()

◆ setRedirectedFrom()

◆ showDeletedRevisionHeader()

◆ showDiffPage()

◆ showMissingArticle()

◆ showNamespaceHeader()

◆ showPatrolFooter()

◆ showRedirectedFromHeader()

◆ showViewError()

◆ showViewFooter()

◆ tryFileCache()

◆ unprotect()

◆ view()

◆ viewRedirect()

Member Data Documentation

◆ $fetchResult

◆ $linkRenderer

◆ $mContext

◆ $mOldId

◆ $mPage

◆ $mParserOutput

◆ $mRedirectedFrom

◆ $mRedirectUrl

◆ $mRevisionRecord

◆ $revisionStore

◆ $userNameUtils

◆ $viewIsRenderAction

◆ $watchlistManager