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

Inheritance diagram for Article:

[legend]

Collaboration diagram for Article:

[legend]

Public Member Functions
	__call ( $fname, $args)
	Use PHP's magic __call handler to transform instance calls to WikiPage functions for backwards compatibility. More...

	__construct (Title $title, $oldId=null)
	Constructor and clear the article. More...

	__get ( $fname)
	Use PHP's magic __get handler to handle accessing of raw WikiPage fields for backwards compatibility. More...

	__set ( $fname, $fvalue)
	Use PHP's magic __set handler to handle setting of raw WikiPage fields for backwards compatibility. More...

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

	clear ()
	Clear the object. 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)
	Perform a deletion and output success or failure messages. More...

	doDeleteArticle ( $reason, $suppress=false, $id=0, $commit=true, &$error='')

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

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

	fetchContent ()
	Get text of an article from database Does NOT follow redirects. More...

	generateReason (&$hasHistory)

	getContent ()
	Note that getContent/loadContent do not follow redirects anymore. 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, User $user=null)
	#- More...

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

	getRevisionFetched ()
	Get the fetched Revision object depending on request parameters or null on failure. More...

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

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

	info ()
	Info about this page. More...

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

	isFileCacheable ()
	Check if the page can be cached. More...

	loadContent ()
	Load the revision (including text) into this object. More...

	protect ()
	action=protect handler More...

	purge ()
	Handle action=purge. More...

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

	revert ()
	Handle action=revert. More...

	rollback ()
	Handle action=rollback. 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...

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

	showDiffPage ()
	Show a diff page according to current request variables. 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...

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

	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)
	View redirect. 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	getAutosummary ( $oldtext, $newtext, $flags)

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	onArticleCreate ( $title)

static	onArticleDelete ( $title)

static	onArticleEdit ( $title)

static	selectFields ()

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

	newPage (Title $title)

	showCssOrJsPage ( $showCacheHint=true)
	Show a page view for a page formatted as CSS or JavaScript. More...

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

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

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

ParserOptions	$mParserOptions
	ParserOptions object for $wgUser articles $mParserOptions. More...

string	$mContent
	Text of the revision we are working on $mContent. More...

Content	$mContentObject
	Content of the revision we are working on. More...

bool	$mContentLoaded = false
	Is the content ($mContent) already loaded? $mContentLoaded. More...

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

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

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

int	$mRevIdFetched = 0
	Revision ID of revision we are working on $mRevIdFetched. More...

Revision	$mRevision = null
	Revision we are working on $mRevision. More...

ParserOutput	$mParserOutput
	ParserOutput object $mParserOutput. More...

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

See design.txt for an overview. Note: edit user interface and cache support functions have been moved to separate EditPage and HTMLFileCache classes.

Definition at line 36 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.
$oldId	Integer revision ID, null to fetch from request, zero for current

Definition at line 110 of file Article.php.

References newPage().

Member Function Documentation

◆ __call()

Article::__call	(	$fname,
		$args
	)

Use PHP's magic __call handler to transform instance calls to WikiPage functions for backwards compatibility.

Parameters

string	$fname	Name of called method
array	$args	Arguments to the method

Returns: mixed

Definition at line 2009 of file Article.php.

References $args, $fname, and array().

◆ __get()

Article::__get ( $fname )

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

Parameters

string $fname Field name

Definition at line 1974 of file Article.php.

References $fname.

◆ __set()

Article::__set	(	$fname,
		$fvalue
	)

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

Parameters

string	$fname	Field name
	$fvalue	mixed New value

Definition at line 1989 of file Article.php.

References $fname, and array().

◆ adjustDisplayTitle()

Article::adjustDisplayTitle ( ParserOutput $pOutput )

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

Parameters

$pOutput ParserOutput

Definition at line 770 of file Article.php.

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

Referenced by view().

◆ clear()

Article::clear ( )

Clear the object.

Definition at line 211 of file Article.php.

◆ commitRollback()

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

Parameters

$fromP
$summary
$bot
$resultDetails
$guser	User

Returns: array

Definition at line 2088 of file Article.php.

References $summary, and getContext().

◆ confirmDelete()

Article::confirmDelete ( $reason )

Output deletion confirmation dialog.

Todo:: FIXME: Move to another file?

Parameters

string $reason prefilled reason

Definition at line 1641 of file Article.php.

References $form, $link, $title, $user, array(), Xml\checkLabel(), Xml\closeElement(), Xml\element(), getContext(), getTitle(), Html\hidden(), Html\input(), Xml\label(), Linker\link(), Xml\listDropDown(), Title\makeTitle(), NS_MEDIAWIKI, Xml\openElement(), LogEventsList\showLogExtract(), Xml\submitButton(), Xml\tags(), text, wfDebug(), wfMessage(), and wfRunHooks().

Referenced by delete().

◆ delete()

Article::delete ( )

UI entry point for page deletion.

Reimplemented in ImagePage.

Definition at line 1531 of file Article.php.

References $e, $title, $user, array(), confirmDelete(), doDelete(), WatchAction\doWatchOrUnwatch(), Xml\element(), generateReason(), getContext(), getTitle(), global, Linker\linkKnown(), LogEventsList\showLogExtract(), wfDebug(), wfEscapeWikiText(), wfMessage(), and wfReadOnly().

◆ doDelete()

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

Perform a deletion and output success or failure messages.

Parameters

string	$reason
bool	$suppress

Definition at line 1761 of file Article.php.

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

Referenced by delete().

◆ doDeleteArticle()

Article::doDeleteArticle	(		$reason,
			$suppress = `false`,
			$id = `0`,
			$commit = `true`,
		&	$error = `''`
	)

Parameters

$reason	string
$suppress	bool
$id	int
$commit	bool
$error	string

Returns: bool

Definition at line 2060 of file Article.php.

References $error.

◆ doRollback()

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

Parameters

$fromP
$summary
$token
$bot
$resultDetails
$user	User

Returns: array

Definition at line 2075 of file Article.php.

References $summary, $user, and getContext().

◆ doUpdateRestrictions()

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

Parameters

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

Returns: Status

Definition at line 2027 of file Article.php.

References $limit, and $user.

◆ fetchContent()

Article::fetchContent ( )

Get text of an article from database Does NOT follow redirects.

Access:\n protected

Note: This is really internal functionality that should really NOT be used by other functions. For accessing article content, use the WikiPage class, especially WikiBase::getContent(). However, a lot of legacy code uses this method to retrieve page text from the database, so the function has to remain public for now.

Returns: mixed string containing article contents, or false if null

Deprecated:: in 1.21, use WikiPage::getContent() instead

Definition at line 367 of file Article.php.

References $mContent, array(), ContentHandler\deprecated(), fetchContentObject(), ContentHandler\getContentText(), ContentHandler\runLegacyHooks(), wfProfileIn(), and wfProfileOut().

Referenced by loadContent().

◆ fetchContentObject()

Article::fetchContentObject ( )

protected

Get text content object Does NOT follow redirects.

Todo:: When is this null?

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

Returns: Content|null|boolean false

Since: 1.21

Definition at line 399 of file Article.php.

References $mContentObject, array(), Revision\FOR_THIS_USER, getContext(), getOldID(), getTitle(), Revision\newFromId(), wfDebug(), wfProfileIn(), wfProfileOut(), and wfRunHooks().

Referenced by fetchContent(), getContentObject(), getRevisionFetched(), showCssOrJsPage(), and view().

◆ 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

$policy Mixed, returns empty array on null/false/'', transparent to already-converted arrays, converts String.

Returns: Array: 'index' => <indexpolicy>, 'follow' => <followpolicy>

Definition at line 947 of file Article.php.

References array(), and as.

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

◆ generateReason()

Article::generateReason ( & $hasHistory )

Parameters

$hasHistory bool

Returns: mixed

Definition at line 2097 of file Article.php.

References $title, and ContentHandler\getForTitle().

Referenced by delete().

◆ getAutosummary()

static Article::getAutosummary	(	$oldtext,
		$newtext,
		$flags
	)

static

Parameters

$oldtext
$newtext
$flags

Returns: string

Deprecated:: since 1.21, use ContentHandler::getAutosummary() instead

Definition at line 2140 of file Article.php.

References $flags, and WikiPage\getAutosummary().

Referenced by ArticleTest\testStaticFunctions().

◆ getContent()

Article::getContent ( )

Note that getContent/loadContent do 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:: in 1.21; use WikiPage::getContent() instead

Returns: string Return the text of this revision

Definition at line 233 of file Article.php.

References ContentHandler\deprecated(), getContentObject(), and ContentHandler\getContentText().

◆ getContentObject()

Article::getContentObject ( )

protected

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

Note that getContent/loadContent do 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.

Returns: Content Return the content of this revision

Since: 1.21

Reimplemented in ImagePage.

Definition at line 254 of file Article.php.

References $mContentObject, fetchContentObject(), getContext(), getTitle(), ContentHandler\makeContent(), NS_MEDIAWIKI, wfProfileIn(), and wfProfileOut().

Referenced by getContent(), and view().

◆ getContext()

Article::getContext ( )

Gets the context this Article is executed in.

Returns: IContextSource

Since: 1.18

Definition at line 1922 of file Article.php.

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

Referenced by ImageHistoryPseudoPager\__construct(), adjustDisplayTitle(), CategoryPage\closeShowCategory(), commitRollback(), confirmDelete(), delete(), doDelete(), ImagePage\doRenderLangOpt(), doRollback(), fetchContentObject(), getContentObject(), getOldIDFromRequest(), getParserOptions(), getRobotPolicy(), ImagePage\imageDupes(), ImagePage\imageHistory(), ImagePage\imageLinks(), isFileCacheable(), ImagePage\openShowImage(), ImagePage\printSharedImageText(), ImagePage\render(), render(), setOldSubtitle(), showCssOrJsPage(), showDeletedRevisionHeader(), showDiffPage(), ImagePage\showError(), showMissingArticle(), showNamespaceHeader(), showPatrolFooter(), showRedirectedFromHeader(), showViewFooter(), tryFileCache(), updateRestrictions(), ImagePage\uploadLinksBox(), CategoryPage\view(), ImagePage\view(), view(), and viewRedirect().

◆ getOldID()

Article::getOldID ( )

Returns: int The oldid of the article that is to be shown, 0 for the current revision

Definition at line 284 of file Article.php.

References $mOldId, and getOldIDFromRequest().

Referenced by fetchContentObject(), getRobotPolicy(), 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 297 of file Article.php.

References array(), getContext(), getTitle(), and Revision\newFromId().

Referenced by getOldID().

◆ getPage()

Article::getPage ( )

Get the WikiPage object of this instance.

Since: 1.19

Returns: WikiPage

Definition at line 204 of file Article.php.

References $mPage.

Referenced by view().

◆ getParserOptions()

Article::getParserOptions ( )

Get parser options suitable for rendering the primary article wikitext.

Returns: ParserOptions

Definition at line 1898 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 WikiPage::view is forced to consider, so it's not appropriate to use there.

Since: 1.16 (r52326) for LiquidThreads

Parameters

$oldid	mixed integer Revision ID or null
$user	User The relevant user

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

Definition at line 1867 of file Article.php.

References $user, and getParserOptions().

◆ getRevIdFetched()

Article::getRevIdFetched ( )

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

Returns: int revision ID of last article revision

Definition at line 492 of file Article.php.

References $mRevIdFetched.

Referenced by view().

◆ getRevisionFetched()

Article::getRevisionFetched ( )

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

Since: 1.19

Returns: Revision|null

Definition at line 481 of file Article.php.

References $mRevision, and fetchContentObject().

Referenced by showDiffPage().

◆ getRobotPolicy()

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

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

Parameters

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

Returns: Array the policy that should be set TODO: actions other than 'view'

Definition at line 867 of file Article.php.

References array(), formatRobotPolicy(), getContext(), getOldID(), getTitle(), global, IP\isValid(), Block\newFromTarget(), NS_USER, and NS_USER_TALK.

Referenced by showMissingArticle(), and view().

◆ getTitle()

Article::getTitle ( )

Get the title object of the article.

Returns: Title object of this page

Definition at line 194 of file Article.php.

Referenced by ImageHistoryPseudoPager\__construct(), CategoryPage\closeShowCategory(), confirmDelete(), delete(), doDelete(), ImagePage\doRenderLangOpt(), fetchContentObject(), getContentObject(), getOldIDFromRequest(), getRobotPolicy(), ImagePage\imageDupes(), ImagePage\imageLinks(), isFileCacheable(), ImagePage\loadFile(), ImagePage\openShowImage(), setOldSubtitle(), showCssOrJsPage(), showDeletedRevisionHeader(), showMissingArticle(), showNamespaceHeader(), showPatrolFooter(), showRedirectedFromHeader(), showViewFooter(), tryFileCache(), ImagePage\uploadLinksBox(), CategoryPage\view(), ImagePage\view(), view(), and viewRedirect().

◆ info()

Article::info ( )

Info about this page.

Deprecated:: since 1.19

Definition at line 1936 of file Article.php.

References Action\factory(), and 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 465 of file Article.php.

References getOldID().

Referenced by view().

◆ isFileCacheable()

Article::isFileCacheable ( )

Check if the page can be cached.

Returns: bool

Definition at line 1839 of file Article.php.

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

Referenced by tryFileCache().

◆ loadContent()

Article::loadContent ( )

Load the revision (including text) into this object.

Deprecated:: in 1.19; use fetchContent()

Definition at line 348 of file Article.php.

References fetchContent(), and wfDeprecated().

◆ newFromID()

static Article::newFromID ( $id )

static

Constructor from a page id.

Parameters

int $id article ID to load

Returns: Article|null

Reimplemented in ImagePage, and CategoryPage.

Definition at line 128 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
$context	IContextSource

Returns: Article object

Definition at line 142 of file Article.php.

References $title, array(), Title\makeTitle(), NS_CATEGORY, NS_FILE, NS_MEDIA, and wfRunHooks().

Referenced by ApiParse\execute(), RebuildFileCache\execute(), MediaWiki\initializeArticle(), newFromWikiPage(), and DifferenceEngine\renderNewRevision().

◆ newFromWikiPage()

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

static

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

Parameters

$page	WikiPage
$context	IContextSource

Returns: Article object

Definition at line 174 of file Article.php.

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

Referenced by ApiEditPage\execute(), and MediaWiki\initializeArticle().

◆ newPage()

Article::newPage ( Title $title )

protected

Parameters

$title Title

Returns: WikiPage

Reimplemented in ImagePage, and CategoryPage.

Definition at line 119 of file Article.php.

References $title.

Referenced by __construct().

◆ onArticleCreate()

static Article::onArticleCreate ( $title )

static

Parameters

$title Title

Definition at line 2115 of file Article.php.

References $title, and WikiPage\onArticleCreate().

◆ onArticleDelete()

static Article::onArticleDelete ( $title )

static

Parameters

$title Title

Definition at line 2122 of file Article.php.

References $title, and WikiPage\onArticleDelete().

◆ onArticleEdit()

static Article::onArticleEdit ( $title )

static

Parameters

$title Title

Definition at line 2129 of file Article.php.

References $title, and WikiPage\onArticleEdit().

◆ protect()

Article::protect ( )

action=protect handler

Definition at line 1516 of file Article.php.

References $form.

Referenced by unprotect().

◆ purge()

Article::purge ( )

Handle action=purge.

Deprecated:: since 1.19

Returns: Action|bool|null false if the action is disabled, null if it is not recognised

Definition at line 1946 of file Article.php.

References Action\factory().

◆ render()

Article::render ( )

Handle action=render.

Reimplemented in ImagePage.

Definition at line 1507 of file Article.php.

References getContext(), and view().

◆ revert()

Article::revert ( )

Handle action=revert.

Deprecated:: since 1.19

Definition at line 1954 of file Article.php.

References Action\factory(), and wfDeprecated().

◆ rollback()

Article::rollback ( )

Handle action=rollback.

Deprecated:: since 1.19

Definition at line 1963 of file Article.php.

References Action\factory(), and wfDeprecated().

◆ selectFields()

static Article::selectFields ( )

static

Returns: array

Definition at line 2108 of file Article.php.

References WikiPage\selectFields().

Referenced by ArticleTest\testStaticFunctions().

◆ setContext()

Article::setContext ( $context )

Sets the context this Article is executed in.

Parameters

$context IContextSource

Since: 1.18

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

References $mRevision, $timestamp, $user, array(), getContext(), Linker\getRevDeleteLink(), getTitle(), Linker\linkKnown(), Revision\newFromId(), Linker\revUserTools(), wfMessage(), and wfRunHooks().

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

References $options.

◆ setRedirectedFrom()

Article::setRedirectedFrom ( Title $from )

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

Parameters

$from Title object.

Definition at line 185 of file Article.php.

References $from.

◆ showCssOrJsPage()

Article::showCssOrJsPage ( $showCacheHint = true )

protected

Show a page view for a page formatted as CSS or JavaScript.

To be called by Article::view() only.

This is hooked by SyntaxHighlight_GeSHi to do syntax highlighting of these page views.

Parameters

bool $showCacheHint whether to show a message telling the user to clear the browser cache (default: true).

Definition at line 833 of file Article.php.

References $dir, array(), fetchContentObject(), getContext(), getTitle(), and ContentHandler\runLegacyHooks().

Referenced by view().

◆ 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: boolean true if the view is allowed, false if not.

Definition at line 1278 of file Article.php.

References $link, $user, array(), Revision\DELETED_RESTRICTED, Revision\DELETED_TEXT, getContext(), getOldID(), and getTitle().

Referenced by view().

◆ showDiffPage()

Article::showDiffPage ( )

Show a diff page according to current request variables.

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

Todo:: Make protected

Definition at line 784 of file Article.php.

References $rev, $user, getContext(), getOldID(), getRevisionFetched(), list, 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 1179 of file Article.php.

References $user, array(), getContext(), getOldID(), getRobotPolicy(), getTitle(), global, in, is(), User\isIP(), User\newFromName(), NS_MEDIAWIKI, NS_USER, NS_USER_TALK, LogEventsList\showLogExtract(), user, wfEscapeWikiText(), wfMessage(), and wfRunHooks().

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

References array(), 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 mediawiki.page.patrol.ajax.

Returns: bool

Definition at line 1064 of file Article.php.

References $cache, $dbr, $link, $user, array(), DB_SLAVE, getContext(), getTitle(), global, RecentChange\isInRCLifespan(), Linker\linkKnown(), RecentChange\newFromConds(), wfGetDB(), wfGetMainCache(), wfMemcKey(), wfMessage(), wfProfileIn(), and wfProfileOut().

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: boolean

Definition at line 976 of file Article.php.

References array(), getContext(), getTitle(), global, Linker\linkKnown(), Linker\makeExternalLink(), wfMessage(), and wfRunHooks().

Referenced by view().

◆ showViewFooter()

Article::showViewFooter ( )

Show the footer section of an ordinary page view.

Definition at line 1041 of file Article.php.

References array(), getContext(), getTitle(), IP\isValid(), NS_USER_TALK, showPatrolFooter(), and wfRunHooks().

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: boolean true if cached version send, false otherwise

Definition at line 1809 of file Article.php.

References $cache, array(), getContext(), getTitle(), isFileCacheable(), HTMLFileCache\newFromTitle(), and wfDebug().

Referenced by view().

◆ unprotect()

Article::unprotect ( )

action=unprotect handler (alias)

Definition at line 1524 of file Article.php.

References protect().

◆ updateRestrictions()

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

Parameters

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

Returns: bool

Definition at line 2040 of file Article.php.

References $limit, and getContext().

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

References $error, $pass, $user, adjustDisplayTitle(), array(), fetchContentObject(), getContentObject(), getContext(), getOldID(), getPage(), getParserOptions(), getRevIdFetched(), getRobotPolicy(), getTitle(), global, isCurrent(), ContentHandler\runLegacyHooks(), setOldSubtitle(), showCssOrJsPage(), showDeletedRevisionHeader(), showDiffPage(), showMissingArticle(), showNamespaceHeader(), showRedirectedFromHeader(), showViewFooter(), ParserCache\singleton(), text, tryFileCache(), viewRedirect(), wfDebug(), wfIncrStats(), wfMessage(), wfProfileIn(), wfProfileOut(), and wfRunHooks().

Referenced by render().

◆ viewRedirect()

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

View redirect.

Parameters

$target	Title\|Array of destination(s) to redirect
$appendSubtitle	Boolean [optional]
$forceKnown	Boolean: should the image be shown as a bluelink regardless of existence?

Returns: string containing HMTL with redirect link

Definition at line 1446 of file Article.php.

References $link, $out, $title, array(), as, Html\element(), getContext(), getTitle(), global, Linker\link(), Linker\linkKnown(), and wfMessage().

Referenced by ImagePage\view(), and view().

Member Data Documentation

◆ $mContent

string Article::$mContent

Text of the revision we are working on $mContent.

Definition at line 59 of file Article.php.

Referenced by fetchContent().

◆ $mContentLoaded

bool Article::$mContentLoaded = false

Is the content ($mContent) already loaded? $mContentLoaded.

Definition at line 70 of file Article.php.

◆ $mContentObject

Content Article::$mContentObject

Content of the revision we are working on.

Since: 1.21

Definition at line 65 of file Article.php.

Referenced by fetchContentObject(), and getContentObject().

◆ $mContext

IContextSource Article::$mContext

protected

The context this Article is executed in $mContext.

{

Access:\n private

Definition at line 44 of file Article.php.

Referenced by getContext().

◆ $mOldId

int null Article::$mOldId

The oldid of the article that is to be shown, 0 for the current revision $mOldId.

Definition at line 76 of file Article.php.

Referenced by getOldID().

◆ $mPage

WikiPage Article::$mPage

protected

The WikiPage object of this instance $mPage.

Definition at line 49 of file Article.php.

Referenced by getPage().

◆ $mParserOptions

ParserOptions Article::$mParserOptions

ParserOptions object for $wgUser articles $mParserOptions.

Definition at line 54 of file Article.php.

Referenced by getParserOptions().

◆ $mParserOutput

ParserOutput Article::$mParserOutput

ParserOutput object $mParserOutput.

Definition at line 101 of file Article.php.

◆ $mRedirectedFrom

Title Article::$mRedirectedFrom = null

Title from which we were redirected here $mRedirectedFrom.

Definition at line 81 of file Article.php.

◆ $mRedirectUrl

string false Article::$mRedirectUrl = false

URL to redirect to or false if none $mRedirectUrl.

Definition at line 86 of file Article.php.

◆ $mRevIdFetched

int Article::$mRevIdFetched = 0

Revision ID of revision we are working on $mRevIdFetched.

Definition at line 91 of file Article.php.

Referenced by getRevIdFetched().

◆ $mRevision

Revision Article::$mRevision = null

Revision we are working on $mRevision.

Definition at line 96 of file Article.php.

Referenced by getRevisionFetched(), and setOldSubtitle().

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

includes/Article.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __call()

◆ __get()

◆ __set()

◆ adjustDisplayTitle()

◆ clear()

◆ commitRollback()

◆ confirmDelete()

◆ delete()

◆ doDelete()

◆ doDeleteArticle()

◆ doRollback()

◆ doUpdateRestrictions()

◆ fetchContent()

◆ fetchContentObject()

◆ formatRobotPolicy()

◆ generateReason()

◆ getAutosummary()

◆ getContent()

◆ getContentObject()

◆ getContext()

◆ getOldID()

◆ getOldIDFromRequest()

◆ getPage()

◆ getParserOptions()

◆ getParserOutput()

◆ getRevIdFetched()

◆ getRevisionFetched()

◆ getRobotPolicy()

◆ getTitle()

◆ info()

◆ isCurrent()

◆ isFileCacheable()

◆ loadContent()

◆ newFromID()

◆ newFromTitle()

◆ newFromWikiPage()

◆ newPage()

◆ onArticleCreate()

◆ onArticleDelete()

◆ onArticleEdit()

◆ protect()

◆ purge()

◆ render()

◆ revert()

◆ rollback()

◆ selectFields()

◆ setContext()

◆ setOldSubtitle()

◆ setParserOptions()

◆ setRedirectedFrom()

◆ showCssOrJsPage()

◆ showDeletedRevisionHeader()

◆ showDiffPage()

◆ showMissingArticle()

◆ showNamespaceHeader()

◆ showPatrolFooter()

◆ showRedirectedFromHeader()

◆ showViewFooter()

◆ tryFileCache()

◆ unprotect()

◆ updateRestrictions()

◆ view()

◆ viewRedirect()

Member Data Documentation

◆ $mContent

◆ $mContentLoaded

◆ $mContentObject

◆ $mContext

◆ $mOldId

◆ $mPage

◆ $mParserOptions

◆ $mParserOutput

◆ $mRedirectedFrom