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)
	Constructor and clear the article. More...

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

	checkFlags ( $flags)
	Call to WikiPage function for backwards compatibility. More...

	checkTouched ()

	clear ()
	Clear the object. More...

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

	commitRollback ( $fromP, $summary, $bot, &$resultDetails, User $guser=null)

	confirmDelete ( $reason)
	Output deletion confirmation dialog. More...

	delete ()
	UI entry point for page deletion. More...

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

	doDeleteArticle ( $reason, $suppress=false, $u1=null, $u2=null, &$error='', $immediate=false)

	doDeleteArticleReal ( $reason, $suppress=false, $u1=null, $u2=null, &$error='', User $user=null, $tags=[], $immediate=false)
	Call to WikiPage function for backwards compatibility. More...

	doDeleteUpdates ( $id, Content $content=null, $revision=null, User $user=null)

	doEditUpdates (Revision $revision, User $user, array $options=[])
	Call to WikiPage function for backwards compatibility. More...

	doPurge ()

	doRollback ( $fromP, $summary, $token, $bot, &$resultDetails, User $user=null)

	doUpdateRestrictions (array $limit, array $expiry, &$cascade, $reason, User $user)

	doViewUpdates (User $user, $oldid=0)

	exists ()

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

	followRedirect ()

	generateReason (&$hasHistory)

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

	getAutoDeleteReason (&$hasHistory)

	getCategories ()

	getComment ( $audience=RevisionRecord::FOR_PUBLIC, User $user=null)
	Call to WikiPage function for backwards compatibility. More...

	getContentHandler ()

	getContentModel ()

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

	getContributors ()

	getCreator ( $audience=RevisionRecord::FOR_PUBLIC, User $user=null)
	Call to WikiPage function for backwards compatibility. More...

	getDeletionUpdates (Content $content=null)

	getHiddenCategories ()

	getId ()

	getLatest ()

	getLinksTimestamp ()

	getMinorEdit ()

	getOldestRevision ()

	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, User $user=null)
	#- More...

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

	getRedirectTarget ()

	getRedirectURL ( $rt)

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

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

	getRevisionFetched ()
	Get the fetched Revision object depending on request parameters or null on failure. 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...

	getTouched ()

	getUndoContent (Revision $undo, Revision $undoafter=null)
	Call to WikiPage function for backwards compatibility. More...

	getUser ( $audience=RevisionRecord::FOR_PUBLIC, User $user=null)

	getUserText ( $audience=RevisionRecord::FOR_PUBLIC, User $user=null)

	hasViewableContent ()

	insertOn ( $dbw, $pageId=null)

	insertProtectNullRevision ( $revCommentMsg, array $limit, array $expiry, $cascade, $reason, $user=null)

	insertRedirect ()

	insertRedirectEntry (Title $rt, $oldLatest=null)

	isCountable ( $editInfo=false)

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

	isRedirect ()

	loadFromRow ( $data, $from)

	loadPageData ( $from='fromdb')

	lockAndGetLatest ()

	makeParserOptions ( $context)

	pageDataFromId ( $dbr, $id, $options=[])

	pageDataFromTitle ( $dbr, $title, $options=[])

	prepareContentForEdit (Content $content, $revision=null, User $user=null, $serialFormat=null, $useCache=true)
	Call to WikiPage function for backwards compatibility. More...

	protect ()
	action=protect handler More...

	protectDescription (array $limit, array $expiry)

	protectDescriptionLog (array $limit, array $expiry)

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

	replaceSectionAtRev ( $sectionId, Content $sectionContent, $sectionTitle='', $baseRevId=null)

	replaceSectionContent ( $sectionId, Content $sectionContent, $sectionTitle='', $edittime=null)
	Call to WikiPage function for backwards compatibility. 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...

	setParserOptions (ParserOptions $options)
	Override the ParserOptions used to render the primary article wikitext. More...

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

	setTimestamp ( $ts)

	shouldCheckParserCache (ParserOptions $parserOptions, $oldId)

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

	supportsSections ()

	triggerOpportunisticLinksUpdate (ParserOutput $parserOutput)

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

	updateCategoryCounts (array $added, array $deleted, $id=0)

	updateIfNewerOn ( $dbw, $revision)
	Call to WikiPage function for backwards compatibility. More...

	updateRedirectOn ( $dbw, $redirectTitle, $lastRevIsRedirect=null)

	updateRestrictions ( $limit=[], $reason='', &$cascade=0, $expiry=[])

	updateRevisionOn ( $dbw, $revision, $lastRevision=null, $lastRevIsRedirect=null)

	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
bool	$mContentLoaded = false
	Is the target revision loaded? Set by fetchRevisionRecord(). More...

Content null	$mContentObject
	Content of the main slot of $this->mRevisionRecord. More...

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

ParserOptions null	$mParserOptions
	ParserOptions object for $wgUser articles. 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...

int	$mRevIdFetched = 0
	Revision ID of revision that was loaded. More...

Protected Member Functions
	fetchContentObject ()
	Get text content object Does NOT follow redirects. More...

	getContentObject ()
	Returns a Content object representing the pages effective display content, not necessarily the revision's content! More...

	getEmptyPageParserOutput (ParserOptions $options)
	Returns ParserOutput to use when a page does not exist. More...

	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
	applyContentOverride (Content $override)
	Applies a content override by constructing a fake Revision object and assigning it to mRevisionRecord. More...

	getRevisionRedirectTarget (RevisionRecord $revision)

	getSubstituteContent ()
	Returns Content object to use when the page does not exist. More...

	makeFetchErrorContent ()
	Returns a Content object representing any error in $this->fetchContent, or null if there is no such error. More...

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

	$mRevisionRecord = null

PermissionManager	$permManager

RevisionStore	$revisionStore

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 45 of file Article.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor and clear the article.

Parameters

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

Definition at line 157 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, as well as the deprecated $mRevision

Parameters

string $fname Field name

Returns: mixed

Definition at line 2336 of file Article.php.

References fetchRevisionRecord(), and wfDeprecated().

◆ __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, as well as the deprecated $mRevision

Parameters

string	$fname	Field name
mixed	$fvalue	New value

Definition at line 2359 of file Article.php.

References wfDeprecated().

◆ 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 1796 of file Article.php.

References getContext(), getTitle(), Skin\makeUrl(), and wfMessage().

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 917 of file Article.php.

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

Referenced by view().

◆ applyContentOverride()

Article::applyContentOverride ( Content $override )

private

Applies a content override by constructing a fake Revision object and assigning it to mRevisionRecord.

The fake revision will not have a user, timestamp or summary set.

Todo:: This mechanism was created mainly to accommodate extensions that use the ArticleAfterFetchContentObject. fetchRevisionRecord() presently also uses this mechanism to report errors, but that could be changed to use $this->fetchResult instead.

Todo:: the ArticleAfterFetchContentObject hook was removed; check if this is still needed

Parameters

Content $override Content to be used instead of the actual page content, coming from an extension or representing an error message.

Definition at line 556 of file Article.php.

References getTitle().

Referenced by fetchRevisionRecord().

◆ checkFlags()

Article::checkFlags ( $flags )

Call to WikiPage function for backwards compatibility.

Deprecated:: since 1.35, use WikiPage::exists() instead, or simply omit the EDIT_UPDATE and EDIT_NEW flags. To protect against race conditions, use PageUpdater::grabParentRevision.

See also: WikiPage::checkFlags

Parameters

int $flags

Returns: int

Definition at line 2390 of file Article.php.

References wfDeprecated().

◆ checkTouched()

Article::checkTouched ( )

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

See also: WikiPage::checkTouched

Returns: bool

Definition at line 2400 of file Article.php.

References wfDeprecated().

◆ clear()

Article::clear ( )

Clear the object.

Definition at line 270 of file Article.php.

◆ clearPreparedEdit()

Article::clearPreparedEdit ( )

Call to WikiPage function for backwards compatibility.

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

See also: WikiPage::clearPreparedEdit

Definition at line 2410 of file Article.php.

References wfDeprecated().

◆ commitRollback()

Article::commitRollback	(		$fromP,
			$summary,
			$bot,
		&	$resultDetails,
		User	$guser = `null`
	)

Deprecated:: since 1.35

Definition at line 3189 of file Article.php.

References getContext(), and wfDeprecated().

◆ confirmDelete()

Article::confirmDelete ( $reason )

Output deletion confirmation dialog.

Todo:: Move to another file?

Parameters

string $reason Prefilled reason

Definition at line 1971 of file Article.php.

References $title, CommentStore\COMMENT_CHARACTER_LIMIT, Xml\element(), getContext(), getTitle(), Html\hidden(), Xml\listDropDownOptions(), Xml\listDropDownOptionsOoui(), Message\numParam(), Hooks\run(), LogEventsList\showLogExtract(), wfDebug(), and wfMessage().

Referenced by delete().

◆ delete()

Article::delete ( )

UI entry point for page deletion.

Reimplemented in ImagePage.

Definition at line 1839 of file Article.php.

References $context, $dbr, $title, $wgDeleteRevisionsLimit, confirmDelete(), DB_REPLICA, doDelete(), WatchAction\doWatchOrUnwatch(), Xml\element(), getContext(), getPage(), getTitle(), LogEventsList\showLogExtract(), wfDebug(), wfEscapeWikiText(), wfGetDB(), wfMessage(), and wfReadOnly().

◆ doDelete()

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

Perform a deletion and output success or failure messages.

Parameters

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

Exceptions

FatalError
MWException

Definition at line 2142 of file Article.php.

References $context, Xml\element(), getContext(), getTitle(), Hooks\run(), LogEventsList\showLogExtract(), wfEscapeWikiText(), and wfMessage().

Referenced by delete().

◆ doDeleteArticle()

Article::doDeleteArticle	(		$reason,
			$suppress = `false`,
			$u1 = `null`,
			$u2 = `null`,
		&	$error = `''`,
			$immediate = `false`
	)

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

Parameters

string	$reason
bool	$suppress
int \| null	$u1	Unused
bool \| null	$u2	Unused
string	&$error
bool	$immediate	false allows deleting over time via the job queue

Returns: bool

Exceptions

FatalError
MWException

Definition at line 3145 of file Article.php.

References wfDeprecated().

◆ doDeleteArticleReal()

Article::doDeleteArticleReal	(		$reason,
			$suppress = `false`,
			$u1 = `null`,
			$u2 = `null`,
		&	$error = `''`,
		User	$user = `null`,
			$tags = `[]`,
			$immediate = `false`
	)

Call to WikiPage function for backwards compatibility.

Deprecated:: since 1.35

See also: WikiPage::doDeleteArticleReal

Parameters

string	$reason
bool	$suppress
int \| null	$u1
bool \| null	$u2
array \| string	&$error
User \| null	$user
array	$tags
bool	$immediate

Returns: Status

Definition at line 2429 of file Article.php.

References wfDeprecated().

◆ doDeleteUpdates()

Article::doDeleteUpdates	(		$id,
		Content	$content = `null`,
			$revision = `null`,
		User	$user = `null`
	)

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

See also: WikiPage::doDeleteUpdates

Parameters

int	$id
Content \| null	$content
Revision \| null	$revision
User \| null	$user

Definition at line 2447 of file Article.php.

References $content, and wfDeprecated().

◆ doEditUpdates()

Article::doEditUpdates	(	Revision	$revision,
		User	$user,
		array	$options = `[]`
	)

Call to WikiPage function for backwards compatibility.

Deprecated:: since 1.35, use PageUpdater::doUpdates instead.

See also: WikiPage::doEditUpdates

Parameters

Revision	$revision
User	$user
array	$options

Definition at line 2466 of file Article.php.

References wfDeprecated().

◆ doPurge()

Article::doPurge ( )

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

See also: WikiPage::doPurge

Note: In 1.28 (and only 1.28), this took a $flags parameter that controlled how much purging was done.

Returns: bool

Definition at line 2478 of file Article.php.

References wfDeprecated().

◆ doRollback()

Article::doRollback	(		$fromP,
			$summary,
			$token,
			$bot,
		&	$resultDetails,
		User	$user = `null`
	)

Deprecated:: since 1.35

Parameters

string	$fromP
string	$summary
string	$token
bool	$bot
array	&$resultDetails
User \| null	$user

Returns: array[]

Definition at line 3163 of file Article.php.

References getContext(), and wfDeprecated().

◆ doUpdateRestrictions()

Article::doUpdateRestrictions	(	array	$limit,
		array	$expiry,
		&	$cascade,
			$reason,
		User	$user
	)

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

Parameters

array	$limit
array	$expiry
bool	&$cascade
string	$reason
User	$user

Returns: Status

Definition at line 3105 of file Article.php.

References wfDeprecated().

◆ doViewUpdates()

Article::doViewUpdates	(	User	$user,
			$oldid = `0`
	)

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

See also: WikiPage::doViewUpdates

Parameters

User	$user
int	$oldid

Definition at line 2489 of file Article.php.

References wfDeprecated().

◆ exists()

Article::exists ( )

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

See also: WikiPage::exists

Returns: bool

Definition at line 2499 of file Article.php.

References wfDeprecated().

Referenced by ImagePage\imageHistory().

◆ fetchContentObject()

Article::fetchContentObject ( )

protected

Get text content object Does NOT follow redirects.

Todo:: When is this null?

Deprecated:: since 1.32, use fetchRevisionRecord() instead.

Note: Code that wants to retrieve page content from the database should use WikiPage::getContent().

Returns: Content|null|bool

Since: 1.21

Definition at line 446 of file Article.php.

References $mContentObject, and fetchRevisionRecord().

Referenced by getContentObject().

◆ fetchRevisionRecord()

Article::fetchRevisionRecord ( )

Fetches the revision to work on.

The revision is typically loaded from the database, but may also be a fake representing an error message or content supplied by an extension. Refer to $this->fetchResult for the revision actually loaded from the database, and any errors encountered while doing that.

Public since 1.35

Returns: RevisionRecord|null

Definition at line 465 of file Article.php.

References $mRevisionRecord, applyContentOverride(), getContext(), getOldID(), getTitle(), getUser(), makeFetchErrorContent(), StatusValue\newFatal(), StatusValue\newGood(), and wfDebug().

Referenced by __get(), fetchContentObject(), getRevisionFetched(), showDiffPage(), and view().

◆ followRedirect()

Article::followRedirect ( )

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

See also: WikiPage::followRedirect

Returns: bool|Title|string

Definition at line 2509 of file Article.php.

References wfDeprecated().

◆ 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 1069 of file Article.php.

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

◆ generateReason()

Article::generateReason ( & $hasHistory )

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

Parameters

bool &$hasHistory

Returns: mixed

Definition at line 3204 of file Article.php.

References getPage(), and wfDeprecated().

◆ getActionOverrides()

Article::getActionOverrides ( )

Call to WikiPage function for backwards compatibility.

See also: ContentHandler::getActionOverrides

Returns: array

Definition at line 2519 of file Article.php.

Referenced by Action\factory().

◆ getAutoDeleteReason()

Article::getAutoDeleteReason ( & $hasHistory )

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

See also: WikiPage::getAutoDeleteReason

Parameters

bool &$hasHistory

Returns: string|bool

Definition at line 2529 of file Article.php.

References wfDeprecated().

◆ getCategories()

Article::getCategories ( )

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

See also: WikiPage::getCategories

Returns: TitleArray

Definition at line 2539 of file Article.php.

References wfDeprecated().

◆ getComment()

Article::getComment	(		$audience = `RevisionRecord::FOR_PUBLIC`,
		User	$user = `null`
	)

Call to WikiPage function for backwards compatibility.

Deprecated:: since 1.35

See also: WikiPage::getComment

Parameters

int	$audience
User \| null	$user

Returns: string|null

Definition at line 2552 of file Article.php.

References wfDeprecated().

◆ getContentHandler()

Article::getContentHandler ( )

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

See also: WikiPage::getContentHandler

Returns: ContentHandler

Definition at line 2562 of file Article.php.

References wfDeprecated().

◆ getContentModel()

Article::getContentModel ( )

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

See also: WikiPage::getContentModel

Returns: string

Definition at line 2572 of file Article.php.

References wfDeprecated().

◆ getContentObject()

Article::getContentObject ( )

protected

Returns a Content object representing the pages effective display content, not necessarily the revision's content!

Note that getContent does not follow redirects anymore. If you need to fetch redirectable content easily, try the shortcut in WikiPage::getRedirectTarget()

This function has side effects! Do not use this function if you only want the real revision text if any.

Deprecated:: since 1.32, use fetchRevisionRecord() instead.

Returns: Content

Since: 1.21

Definition at line 302 of file Article.php.

References $content, $mContentObject, fetchContentObject(), and getSubstituteContent().

◆ getContext()

Article::getContext ( )

Gets the context this Article is executed in.

Returns: IContextSource

Since: 1.18

Definition at line 2317 of file Article.php.

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

Referenced by ImageHistoryList\__construct(), ProtectionForm\__construct(), EditPage\__construct(), addHelpLink(), adjustDisplayTitle(), CategoryPage\closeShowCategory(), commitRollback(), confirmDelete(), ImagePage\createXmlOptionStringForLanguage(), ImagePage\delete(), delete(), doDelete(), ImagePage\doRenderLangOpt(), doRollback(), fetchRevisionRecord(), getOldIDFromRequest(), getParserOptions(), getRobotPolicy(), getSubstituteContent(), 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(), showViewFooter(), tryFileCache(), updateRestrictions(), ImagePage\uploadLinksBox(), CategoryPage\view(), ImagePage\view(), view(), and viewRedirect().

◆ getContributors()

Article::getContributors ( )

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

See also: WikiPage::getContributors

Returns: UserArrayFromResult

Definition at line 2582 of file Article.php.

References wfDeprecated().

◆ getCreator()

Article::getCreator	(		$audience = `RevisionRecord::FOR_PUBLIC`,
		User	$user = `null`
	)

Call to WikiPage function for backwards compatibility.

Deprecated:: since 1.35

See also: WikiPage::getCreator

Parameters

int	$audience
User \| null	$user

Returns: User|null

Definition at line 2595 of file Article.php.

References wfDeprecated().

◆ getDeletionUpdates()

Article::getDeletionUpdates ( Content $content = null )

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

See also: WikiPage::getDeletionUpdates

Parameters

Content | null $content

Returns: DeferrableUpdate[]

Definition at line 2606 of file Article.php.

References $content, and wfDeprecated().

◆ getEmptyPageParserOutput()

Article::getEmptyPageParserOutput ( ParserOptions $options )

protected

Returns ParserOutput to use when a page does not exist.

In some cases, we still want to show "virtual" content, e.g. in the MediaWiki namespace, or in the File namespace for non-local files.

Parameters

ParserOptions $options

Returns: ParserOutput

Reimplemented in ImagePage.

Definition at line 345 of file Article.php.

References $content, getSubstituteContent(), and getTitle().

Referenced by showMissingArticle().

◆ getHiddenCategories()

Article::getHiddenCategories ( )

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

See also: WikiPage::getHiddenCategories

Returns: array

Definition at line 2616 of file Article.php.

References wfDeprecated().

◆ getId()

Article::getId ( )

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

See also: WikiPage::getId

Returns: int

Definition at line 2626 of file Article.php.

References wfDeprecated().

Referenced by ImagePage\getEmptyPageParserOutput(), ImagePage\openShowImage(), ImagePage\printSharedImageText(), and ImagePage\view().

◆ getLatest()

Article::getLatest ( )

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

See also: WikiPage::getLatest

Returns: int

Definition at line 2636 of file Article.php.

References wfDeprecated().

◆ getLinksTimestamp()

Article::getLinksTimestamp ( )

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

See also: WikiPage::getLinksTimestamp

Returns: string|null

Definition at line 2646 of file Article.php.

References wfDeprecated().

◆ getMinorEdit()

Article::getMinorEdit ( )

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

See also: WikiPage::getMinorEdit

Returns: bool

Definition at line 2656 of file Article.php.

References wfDeprecated().

◆ getOldestRevision()

Article::getOldestRevision ( )

Deprecated:: since 1.35, use RevisionStore::getFirstRevision

Returns: Revision|null

Definition at line 2665 of file Article.php.

References wfDeprecated().

◆ 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 358 of file Article.php.

References $mOldId, and getOldIDFromRequest().

Referenced by fetchRevisionRecord(), isCurrent(), showDeletedRevisionHeader(), showDiffPage(), showMissingArticle(), ImagePage\view(), and 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 371 of file Article.php.

References $mRevisionRecord, getContext(), and getTitle().

Referenced by getOldID().

◆ getPage()

Article::getPage ( )

Get the WikiPage object of this instance.

Since: 1.19

Returns: WikiPage

Definition at line 263 of file Article.php.

References $mPage.

Referenced by ImageHistoryList\__construct(), EditPage\__construct(), delete(), generateReason(), ImagePage\getDuplicates(), ImagePage\getEmptyPageParserOutput(), ImagePage\getFile(), ImagePage\getForeignCategories(), ImagePage\imageDupes(), ImagePage\isLocal(), ImagePage\loadFile(), ImagePage\openShowImage(), ImagePage\printSharedImageText(), ImagePage\setFile(), CategoryPage\view(), ImagePage\view(), and view().

◆ getParserOptions()

Article::getParserOptions ( )

Get parser options suitable for rendering the primary article wikitext.

Returns: ParserOptions

Definition at line 2293 of file Article.php.

References $mParserOptions, and getContext().

Referenced by getParserOutput(), and view().

◆ getParserOutput()

Article::getParserOutput	(		$oldid = `null`,
		User	$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
User \| null	$user	The relevant user

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

Definition at line 2262 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 235 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 1749 of file Article.php.

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

Referenced by WikitextContent\fillParserOutput().

◆ getRedirectTarget()

Article::getRedirectTarget ( )

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

See also: WikiPage::getRedirectTarget

Returns: Title|null

Definition at line 2675 of file Article.php.

References wfDeprecated().

◆ getRedirectURL()

Article::getRedirectURL ( $rt )

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

See also: WikiPage::getRedirectURL

Parameters

Title $rt

Returns: bool|Title|string

Definition at line 2686 of file Article.php.

References wfDeprecated().

◆ 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 609 of file Article.php.

Referenced by view().

◆ getRevision()

Article::getRevision ( )

Call to WikiPage function for backwards compatibility.

Deprecated:: since 1.35

See also: WikiPage::getRevision

Returns: Revision|null

Definition at line 2697 of file Article.php.

References wfDeprecated().

◆ getRevisionFetched()

Article::getRevisionFetched ( )

Get the fetched Revision object depending on request parameters or null on failure.

The revision returned may be a fake representing an error message or wrapping content supplied by an extension. Refer to $this->fetchResult for the revision actually loaded from the database.

Deprecated:: since 1.35

Since: 1.19

Returns: Revision|null

Definition at line 594 of file Article.php.

References fetchRevisionRecord(), and wfDeprecated().

◆ getRevisionRedirectTarget()

Article::getRevisionRedirectTarget ( RevisionRecord $revision )

private

Parameters

RevisionRecord $revision

Returns: null|Title

Definition at line 905 of file Article.php.

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

Referenced by view().

◆ 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: array The policy that should be set

Todo:: actions other than 'view'

Definition at line 989 of file Article.php.

References $wgArticleRobotPolicies, $wgDefaultRobotPolicy, $wgNamespaceRobotPolicies, formatRobotPolicy(), getContext(), getTitle(), NS_USER, and NS_USER_TALK.

Referenced by showMissingArticle(), and view().

◆ getSubstituteContent()

Article::getSubstituteContent ( )

private

Returns Content object to use when the page does not exist.

Returns: Content

Definition at line 318 of file Article.php.

References $content, getContext(), getTitle(), ContentHandler\makeContent(), and NS_MEDIAWIKI.

Referenced by getContentObject(), and getEmptyPageParserOutput().

◆ getTimestamp()

Article::getTimestamp ( )

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

See also: WikiPage::getTimestamp

Returns: string

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

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

◆ getTouched()

Article::getTouched ( )

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

See also: WikiPage::getTouched

Returns: string

Definition at line 2717 of file Article.php.

References wfDeprecated().

Referenced by CategoryPage\view().

◆ getUndoContent()

Article::getUndoContent	(	Revision	$undo,
		Revision	$undoafter = `null`
	)

Call to WikiPage function for backwards compatibility.

Deprecated:: since 1.35

See also: WikiPage::getUndoContent

Parameters

Revision	$undo
Revision \| null	$undoafter

Returns: Content|bool

Definition at line 2730 of file Article.php.

References wfDeprecated().

◆ getUser()

Article::getUser	(		$audience = `RevisionRecord::FOR_PUBLIC`,
		User	$user = `null`
	)

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

See also: WikiPage::getUser

Parameters

int	$audience
User \| null	$user

Returns: int

Definition at line 2742 of file Article.php.

References wfDeprecated().

Referenced by ImagePage\delete(), fetchRevisionRecord(), ImagePage\getThumbSizes(), updateRestrictions(), ImagePage\uploadLinksBox(), CategoryPage\view(), and ImagePage\view().

◆ getUserText()

Article::getUserText	(		$audience = `RevisionRecord::FOR_PUBLIC`,
		User	$user = `null`
	)

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

See also: WikiPage::getUserText

Parameters

int	$audience
User \| null	$user

Returns: string

Definition at line 2754 of file Article.php.

References wfDeprecated().

◆ hasViewableContent()

Article::hasViewableContent ( )

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

See also: WikiPage::hasViewableContent

Returns: bool

Definition at line 2764 of file Article.php.

References wfDeprecated().

◆ insertOn()

Article::insertOn	(	$dbw,
		$pageId = `null`
	)

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

See also: WikiPage::insertOn

Parameters

IDatabase	$dbw
int \| null	$pageId

Returns: bool|int

Definition at line 2776 of file Article.php.

References wfDeprecated().

◆ insertProtectNullRevision()

Article::insertProtectNullRevision	(		$revCommentMsg,
		array	$limit,
		array	$expiry,
			$cascade,
			$reason,
			$user = `null`
	)

See also: WikiPage::insertProtectNullRevision

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

Parameters

string	$revCommentMsg
array	$limit
array	$expiry
int	$cascade
string	$reason
User \| null	$user

Returns: Revision|null

Definition at line 2792 of file Article.php.

References wfDeprecated().

◆ insertRedirect()

Article::insertRedirect ( )

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

See also: WikiPage::insertRedirect

Returns: Title|null

Definition at line 2806 of file Article.php.

References wfDeprecated().

◆ insertRedirectEntry()

Article::insertRedirectEntry	(	Title	$rt,
			$oldLatest = `null`
	)

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

See also: WikiPage::insertRedirectEntry

Parameters

Title	$rt
int \| null	$oldLatest

Returns: bool

Definition at line 2818 of file Article.php.

References wfDeprecated().

◆ isCountable()

Article::isCountable ( $editInfo = false )

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

See also: WikiPage::isCountable

Parameters

PreparedEdit | bool $editInfo

Returns: bool

Definition at line 2829 of file Article.php.

References wfDeprecated().

◆ 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 572 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 2232 of file Article.php.

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

Referenced by tryFileCache().

◆ isRedirect()

Article::isRedirect ( )

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

See also: WikiPage::isRedirect

Returns: bool

Definition at line 2839 of file Article.php.

References wfDeprecated().

Referenced by showRedirectedFromHeader().

◆ loadFromRow()

Article::loadFromRow	(	$data,
		$from
	)

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

See also: WikiPage::loadFromRow

Parameters

object \| bool	$data
string \| int	$from

Definition at line 2850 of file Article.php.

References wfDeprecated().

◆ loadPageData()

Article::loadPageData ( $from = 'fromdb' )

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

See also: WikiPage::loadPageData

Parameters

object | string | int $from

Definition at line 2860 of file Article.php.

References wfDeprecated().

◆ lockAndGetLatest()

Article::lockAndGetLatest ( )

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

See also: WikiPage::lockAndGetLatest

Returns: int

Definition at line 2870 of file Article.php.

References wfDeprecated().

◆ makeFetchErrorContent()

Article::makeFetchErrorContent ( )

private

Returns a Content object representing any error in $this->fetchContent, or null if there is no such error.

Returns: Content|null

Definition at line 535 of file Article.php.

Referenced by fetchRevisionRecord().

◆ makeParserOptions()

Article::makeParserOptions ( $context )

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

See also: WikiPage::makeParserOptions

Parameters

IContextSource | User | string $context

Returns: ParserOptions

Definition at line 2881 of file Article.php.

References $context, and wfDeprecated().

◆ newFromID()

static Article::newFromID ( $id )

static

Constructor from a page id.

Parameters

int $id Article ID to load

Returns: Article|null

Definition at line 180 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 192 of file Article.php.

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

Referenced by MediaWiki\Permissions\PermissionManager\checkUserBlock(), RebuildFileCache\execute(), ApiParse\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 224 of file Article.php.

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

Referenced by Action\convertPageToArticle(), ApiEditPage\execute(), Action\getActionName(), SkinTemplate\getFooterLinks(), and MediaWiki\initializeArticle().

◆ newPage()

Article::newPage ( Title $title )

protected

Parameters

Title $title

Returns: WikiPage

Reimplemented in ImagePage, and CategoryPage.

Definition at line 171 of file Article.php.

References $title.

Referenced by __construct().

◆ pageDataFromId()

Article::pageDataFromId	(	$dbr,
		$id,
		$options = `[]`
	)

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

See also: WikiPage::pageDataFromId

Parameters

IDatabase	$dbr
int	$id
array	$options

Returns: object|bool

Definition at line 2894 of file Article.php.

References $dbr, and wfDeprecated().

◆ pageDataFromTitle()

Article::pageDataFromTitle	(	$dbr,
		$title,
		$options = `[]`
	)

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

See also: WikiPage::pageDataFromTitle

Parameters

IDatabase	$dbr
Title	$title
array	$options

Returns: object|bool

Definition at line 2907 of file Article.php.

References $dbr, $title, and wfDeprecated().

◆ prepareContentForEdit()

Article::prepareContentForEdit	(	Content	$content,
			$revision = `null`,
		User	$user = `null`,
			$serialFormat = `null`,
			$useCache = `true`
	)

Call to WikiPage function for backwards compatibility.

Deprecated:: since 1.35 with PreparedEdit. use

See also: \MediaWiki\Storage\DerivedPageDataUpdater instead.; WikiPage::prepareContentForEdit

Parameters

Content	$content
Revision \| RevisionRecord \| null	$revision
User \| null	$user
string \| null	$serialFormat
bool	$useCache

Returns: PreparedEdit

Definition at line 2925 of file Article.php.

References $content, and wfDeprecated().

◆ protect()

Article::protect ( )

action=protect handler

Definition at line 1824 of file Article.php.

Referenced by unprotect().

◆ protectDescription()

Article::protectDescription	(	array	$limit,
		array	$expiry
	)

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

See also: WikiPage::protectDescription

Parameters

array	$limit
array	$expiry

Returns: string

Definition at line 2943 of file Article.php.

References wfDeprecated().

◆ protectDescriptionLog()

Article::protectDescriptionLog	(	array	$limit,
		array	$expiry
	)

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

See also: WikiPage::protectDescriptionLog

Parameters

array	$limit
array	$expiry

Returns: string

Definition at line 2955 of file Article.php.

References wfDeprecated().

◆ 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 1380 of file Article.php.

References $cache.

Referenced by LocalFile\recordUpload2().

◆ render()

Article::render ( )

Handle action=render.

Definition at line 1813 of file Article.php.

References getContext(), and view().

◆ replaceSectionAtRev()

Article::replaceSectionAtRev	(		$sectionId,
		Content	$sectionContent,
			$sectionTitle = `''`,
			$baseRevId = `null`
	)

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

See also: WikiPage::replaceSectionAtRev

Parameters

string \| int \| null \| bool	$sectionId
Content	$sectionContent
string	$sectionTitle
int \| null	$baseRevId

Returns: Content|null

Definition at line 2969 of file Article.php.

References wfDeprecated().

◆ replaceSectionContent()

Article::replaceSectionContent	(		$sectionId,
		Content	$sectionContent,
			$sectionTitle = `''`,
			$edittime = `null`
	)

Call to WikiPage function for backwards compatibility.

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

See also: WikiPage::replaceSectionContent

Parameters

string \| int \| null \| bool	$sectionId
Content	$sectionContent
string	$sectionTitle
string \| null	$edittime

Returns: Content|null

Definition at line 2989 of file Article.php.

References wfDeprecated().

◆ setContext()

Article::setContext ( $context )

Sets the context this Article is executed in.

Parameters

IContextSource $context

Since: 1.18

Definition at line 2307 of file Article.php.

References $context.

◆ 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 1573 of file Article.php.

References $context, $mRevisionRecord, getContext(), Linker\getRevDeleteLink(), getTitle(), Linker\revComment(), Linker\revUserTools(), and Hooks\run().

Referenced by view().

◆ setParserOptions()

Article::setParserOptions ( ParserOptions $options )

Override the ParserOptions used to render the primary article wikitext.

Parameters

ParserOptions $options

Exceptions

MWException If the parser options where already initialized.

Definition at line 2280 of file Article.php.

◆ 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 244 of file Article.php.

◆ setTimestamp()

Article::setTimestamp ( $ts )

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

See also: WikiPage::setTimestamp

Parameters

string $ts

Definition at line 3003 of file Article.php.

References wfDeprecated().

◆ shouldCheckParserCache()

Article::shouldCheckParserCache	(	ParserOptions	$parserOptions,
			$oldId
	)

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

See also: WikiPage::shouldCheckParserCache

Parameters

ParserOptions	$parserOptions
int	$oldId

Returns: bool

Definition at line 3015 of file Article.php.

References wfDeprecated().

◆ 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 1526 of file Article.php.

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

Referenced by view().

◆ 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 932 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 1389 of file Article.php.

References $dbr, $lang, $permManager, $title, $wgSend404Code, DB_REPLICA, getContext(), getEmptyPageParserOutput(), ObjectCache\getInstance(), getOldID(), getRobotPolicy(), getTitle(), User\isIP(), ParserOptions\newCanonical(), User\newFromName(), NS_MEDIAWIKI, NS_USER, NS_USER_TALK, Xml\openElement(), Hooks\run(), LogEventsList\showLogExtract(), wfEscapeWikiText(), wfGetDB(), and wfMessage().

Referenced by view().

◆ showNamespaceHeader()

Article::showNamespaceHeader ( )

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

For Article::view().

Definition at line 1175 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::preventClickjacking() and load a JS module.

Returns: bool

Definition at line 1211 of file Article.php.

References $cache, $dbr, $title, $wgUseFilePatrol, $wgUseNPPatrol, $wgUseRCPatrol, DB_REPLICA, getContext(), getTitle(), RecentChange\isInRCLifespan(), RecentChange\newFromConds(), NS_FILE, RC_LOG, Hooks\run(), 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 1098 of file Article.php.

References $context, $wgRedirectSources, getContext(), getTitle(), isRedirect(), Linker\makeExternalLink(), and Hooks\run().

Referenced by view().

◆ showViewFooter()

Article::showViewFooter ( )

Show the footer section of an ordinary page view.

Definition at line 1187 of file Article.php.

References getContext(), getTitle(), NS_USER_TALK, Hooks\run(), and showPatrolFooter().

Referenced by view().

◆ supportsSections()

Article::supportsSections ( )

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

See also: WikiPage::supportsSections

Returns: bool

Definition at line 3025 of file Article.php.

References wfDeprecated().

◆ triggerOpportunisticLinksUpdate()

Article::triggerOpportunisticLinksUpdate ( ParserOutput $parserOutput )

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

See also: WikiPage::triggerOpportunisticLinksUpdate

Parameters

ParserOutput $parserOutput

Definition at line 3035 of file Article.php.

References wfDeprecated().

◆ 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 2201 of file Article.php.

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

Referenced by view().

◆ unprotect()

Article::unprotect ( )

action=unprotect handler (alias)

Definition at line 1832 of file Article.php.

References protect().

◆ updateCategoryCounts()

Article::updateCategoryCounts	(	array	$added,
		array	$deleted,
			$id = `0`
	)

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

See also: WikiPage::updateCategoryCounts

Parameters

array	$added
array	$deleted
int	$id

Definition at line 3047 of file Article.php.

References wfDeprecated().

◆ updateIfNewerOn()

Article::updateIfNewerOn	(	$dbw,
		$revision
	)

Call to WikiPage function for backwards compatibility.

Deprecated:: since 1.35

See also: WikiPage::updateIfNewerOn

Parameters

IDatabase	$dbw
Revision	$revision

Returns: bool

Definition at line 3060 of file Article.php.

References wfDeprecated().

◆ updateRedirectOn()

Article::updateRedirectOn	(	$dbw,
		$redirectTitle,
		$lastRevIsRedirect = `null`
	)

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

See also: WikiPage::updateRedirectOn

Parameters

IDatabase	$dbw
Title \| null	$redirectTitle
null \| bool	$lastRevIsRedirect

Returns: bool

Definition at line 3073 of file Article.php.

References wfDeprecated().

◆ updateRestrictions()

Article::updateRestrictions	(		$limit = `[]`,
			$reason = `''`,
		&	$cascade = `0`,
			$expiry = `[]`
	)

Deprecated:: since 1.35, use WikiPage::updateRestrictions

Parameters

array	$limit
string	$reason
int	&$cascade
array	$expiry

Returns: bool

Definition at line 3120 of file Article.php.

References getContext(), getUser(), and wfDeprecated().

◆ updateRevisionOn()

Article::updateRevisionOn	(	$dbw,
		$revision,
		$lastRevision = `null`,
		$lastRevIsRedirect = `null`
	)

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

See also: WikiPage::updateRevisionOn

Parameters

IDatabase	$dbw
Revision	$revision
int \| null	$lastRevision
bool \| null	$lastRevIsRedirect

Returns: bool

Definition at line 3087 of file Article.php.

References wfDeprecated().

◆ 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 621 of file Article.php.

References $lang, $wgUseFileCache, adjustDisplayTitle(), fetchRevisionRecord(), getContext(), getOldID(), getPage(), getParserOptions(), getRevIdFetched(), getRevisionRedirectTarget(), getRobotPolicy(), getTitle(), isCurrent(), EditPage\POST_EDIT_COOKIE_KEY_PREFIX, Hooks\run(), setOldSubtitle(), showDeletedRevisionHeader(), showDiffPage(), showMissingArticle(), showNamespaceHeader(), showRedirectedFromHeader(), showViewFooter(), tryFileCache(), 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 1727 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.

The information in $fetchResult is duplicated by the following deprecated public fields: $mRevIdFetched, $mContentLoaded (and $mContentObject) also typically duplicate information of the loaded revision, but may be overwritten by extensions or due to errors.

Definition at line 108 of file Article.php.

◆ $linkRenderer

LinkRenderer Article::$linkRenderer

protected

Definition at line 127 of file Article.php.

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

◆ $mContentLoaded

bool Article::$mContentLoaded = false

Is the target revision loaded? Set by fetchRevisionRecord().

Deprecated:: since 1.32. Whether content has been loaded should not be relevant to code outside this class.

Definition at line 78 of file Article.php.

◆ $mContentObject

Content null Article::$mContentObject

Content of the main slot of $this->mRevisionRecord.

Note: This variable is read only, setting it has no effect. Extensions that wish to override the output of Article::view should use a hook.

Todo:: MCR: Remove in 1.33

Deprecated:: since 1.32

Since: 1.21

Definition at line 70 of file Article.php.

Referenced by fetchContentObject(), and getContentObject().

◆ $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 51 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.

See also: $mRevIdFetched

Definition at line 85 of file Article.php.

Referenced by getOldID().

◆ $mPage

WikiPage Article::$mPage

protected

The WikiPage object of this instance.

Definition at line 54 of file Article.php.

Referenced by getPage().

◆ $mParserOptions

ParserOptions null Article::$mParserOptions

ParserOptions object for $wgUser articles.

Initialized by getParserOptions by calling $this->mPage->makeParserOptions().

Definition at line 60 of file Article.php.

Referenced by getParserOptions().

◆ $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 115 of file Article.php.

◆ $mRedirectedFrom

Title null Article::$mRedirectedFrom = null

Title from which we were redirected here, if any.

Definition at line 88 of file Article.php.

Referenced by getRedirectedFrom().

◆ $mRedirectUrl

string bool Article::$mRedirectUrl = false

URL to redirect to or false if none.

Definition at line 91 of file Article.php.

◆ $mRevIdFetched

int Article::$mRevIdFetched = 0

Revision ID of revision that was loaded.

See also: $mOldId

Deprecated:: since 1.32, use getRevIdFetched() instead.

Definition at line 98 of file Article.php.

◆ $mRevisionRecord

Article::$mRevisionRecord = null

private

Definition at line 150 of file Article.php.

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

◆ $permManager

PermissionManager Article::$permManager

private

Definition at line 132 of file Article.php.

Referenced by showMissingArticle().

◆ $revisionStore

RevisionStore Article::$revisionStore

private

Definition at line 137 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 122 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()

◆ applyContentOverride()

◆ checkFlags()

◆ checkTouched()

◆ clear()

◆ clearPreparedEdit()

◆ commitRollback()

◆ confirmDelete()

◆ delete()

◆ doDelete()

◆ doDeleteArticle()

◆ doDeleteArticleReal()

◆ doDeleteUpdates()

◆ doEditUpdates()

◆ doPurge()

◆ doRollback()

◆ doUpdateRestrictions()

◆ doViewUpdates()

◆ exists()

◆ fetchContentObject()

◆ fetchRevisionRecord()

◆ followRedirect()

◆ formatRobotPolicy()

◆ generateReason()

◆ getActionOverrides()

◆ getAutoDeleteReason()

◆ getCategories()

◆ getComment()

◆ getContentHandler()

◆ getContentModel()

◆ getContentObject()

◆ getContext()

◆ getContributors()

◆ getCreator()

◆ getDeletionUpdates()

◆ getEmptyPageParserOutput()

◆ getHiddenCategories()

◆ getId()

◆ getLatest()

◆ getLinksTimestamp()

◆ getMinorEdit()

◆ getOldestRevision()

◆ getOldID()

◆ getOldIDFromRequest()

◆ getPage()

◆ getParserOptions()

◆ getParserOutput()

◆ getRedirectedFrom()

◆ getRedirectHeaderHtml()

◆ getRedirectTarget()

◆ getRedirectURL()

◆ getRevIdFetched()

◆ getRevision()

◆ getRevisionFetched()

◆ getRevisionRedirectTarget()

◆ getRobotPolicy()

◆ getSubstituteContent()

◆ getTimestamp()

◆ getTitle()

◆ getTouched()

◆ getUndoContent()

◆ getUser()

◆ getUserText()

◆ hasViewableContent()

◆ insertOn()

◆ insertProtectNullRevision()