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

Inheritance diagram for Article:

Collaboration diagram for Article:

Public Member Functions
	__call ($fname, $args)
	Use PHP's magic __call handler to transform instance calls to WikiPage functions for backwards compatibility.
	__construct (Title $title, $oldId=null)
	Constructor and clear the article.
	__get ($fname)
	Use PHP's magic __get handler to handle accessing of raw WikiPage fields for backwards compatibility.
	__set ($fname, $fvalue)
	Use PHP's magic __set handler to handle setting of raw WikiPage fields for backwards compatibility.
	adjustDisplayTitle (ParserOutput $pOutput)
	Adjust title for pages with displaytitle, -{T\|}- or language conversion.
	clear ()
	Clear the object.
	commitRollback ($fromP, $summary, $bot, &$resultDetails, User $guser=null)
	confirmDelete ($reason)
	Output deletion confirmation dialog.
	delete ()
	UI entry point for page deletion.
	doDelete ($reason, $suppress=false)
	Perform a deletion and output success or failure messages.
	doDeleteArticle ($reason, $suppress=false, $id=0, $commit=true, &$error= '')
	doRedirect ($noRedir=false, $sectionAnchor= '', $extraQuery= '')
	Output a redirect back to the article.
	doRollback ($fromP, $summary, $token, $bot, &$resultDetails, User $user=null)
	doUnwatch ()
	Stop watching a page.
	doUpdateRestrictions (array $limit, array $expiry, &$cascade, $reason, User $user)
	doWatch ()
	Add this page to the current user's watchlist.
	fetchContent ()
	Get text of an article from database Does NOT follow redirects.
	forUpdate ()
	No-op.
	generateReason (&$hasHistory)
	getContent ()
	Note that getContent/loadContent do not follow redirects anymore.
	getContext ()
	Gets the context this Article is executed in.
	getOldID ()
	getOldIDFromRequest ()
	Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect.
	getPage ()
	Get the WikiPage object of this instance.
	getParserOptions ()
	Get parser options suitable for rendering the primary article wikitext.
	getParserOutput ($oldid=null, User $user=null)
	#@-
	getRevIdFetched ()
	Use this to fetch the rev ID used on page views.
	getRevisionFetched ()
	Get the fetched Revision object depending on request parameters or null on failure.
	getRobotPolicy ($action, $pOutput=null)
	Get the robot policy to be used for the current view.
	getTitle ()
	Get the title object of the article.
	info ()
	Info about this page.
	isCurrent ()
	Returns true if the currently-referenced revision is the current edit to this page (and it exists).
	isFileCacheable ()
	Check if the page can be cached.
	loadContent ()
	Load the revision (including text) into this object.
	markpatrolled ()
	Mark this particular edit/page as patrolled.
	protect ()
	action=protect handler
	purge ()
	Handle action=purge.
	render ()
	Handle action=render.
	revert ()
	Handle action=revert.
	rollback ()
	Handle action=rollback.
	setContext ($context)
	Sets the context this Article is executed in.
	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 ->
	setParserOptions (ParserOptions $options)
	Override the ParserOptions used to render the primary article wikitext.
	setRedirectedFrom (Title $from)
	Tell the page view functions that this view was redirected from another page on the wiki.
	showDeletedRevisionHeader ()
	If the revision requested for view is deleted, check permissions.
	showDiffPage ()
	Show a diff page according to current request variables.
	showMissingArticle ()
	Show the error text for a missing article.
	showNamespaceHeader ()
	Show a header specific to the namespace currently being viewed, like [[MediaWiki:Talkpagetext]].
	showPatrolFooter ()
	If patrol is possible, output a patrol UI box.
	showRedirectedFromHeader ()
	If this request is a redirect view, send "redirected from" subtitle to the output.
	showViewFooter ()
	Show the footer section of an ordinary page view.
	unprotect ()
	action=unprotect handler (alias)
	unwatch ()
	User interface handler for the "unwatch" action.
	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.
	viewRedirect ($target, $appendSubtitle=true, $forceKnown=false)
	View redirect.
	watch ()
	User-interface handler for the "watch" action.
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().
static	getAutosummary ($oldtext, $newtext, $flags)
static	newFromID ($id)
	Constructor from a page id.
static	newFromTitle ($title, IContextSource $context)
	Create an Article object of the appropriate class for the given page.
static	newFromWikiPage (WikiPage $page, IContextSource $context)
	Create an Article object of the appropriate class for the given page.
static	onArticleCreate ($title)
static	onArticleDelete ($title)
static	onArticleEdit ($title)
static	selectFields ()
Protected Member Functions
	fetchContentObject ()
	Get text content object Does NOT follow redirects.
	getContentObject ()
	Returns a Content object representing the pages effective display content, not necessarily the revision's content!
	newPage (Title $title)
	showCssOrJsPage ($showCacheHint=true)
	Show a page view for a page formatted as CSS or JavaScript.
	tryFileCache ()
	checkLastModified returns true if it has taken care of all output to the client that is necessary for this request.
IContextSource	$mContext
	The context this Article is executed in $mContext.
WikiPage	$mPage
	The WikiPage object of this instance $mPage.
ParserOptions	$mParserOptions
	ParserOptions object for $wgUser articles $mParserOptions.
string	$mContent
	Text of the revision we are working on $mContent.
Content	$mContentObject
	Content of the revision we are working on.
bool	$mContentLoaded = false
	Is the content ($mContent) already loaded? $mContentLoaded.
int null	$mOldId
	The oldid of the article that is to be shown, 0 for the current revision $mOldId.
Title	$mRedirectedFrom = null
	Title from which we were redirected here $mRedirectedFrom.
string false	$mRedirectUrl = false
	URL to redirect to or false if none $mRedirectUrl.
int	$mRevIdFetched = 0
	Revision ID of revision we are working on $mRevIdFetched.
Revision	$mRevision = null
	Revision we are working on $mRevision.
ParserOutput	$mParserOutput
	ParserOutput object $mParserOutput.

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

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.

Member Function Documentation

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

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

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

Article::adjustDisplayTitle ( ParserOutput $ pOutput )

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

Parameters:

$pOutput ParserOutput

Definition at line 767 of file Article.php.

Article::clear ( )

Clear the object.

Definition at line 211 of file Article.php.

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

Parameters:

$fromP
$summary
$bot
$resultDetails
$guser	User

Returns:: array

Definition at line 2086 of file Article.php.

Article::confirmDelete ( $ reason )

Output deletion confirmation dialog.

Todo:: FIXME: Move to another file?

Parameters:

string $reason prefilled reason

Definition at line 1589 of file Article.php.

Article::delete ( )

UI entry point for page deletion.

Reimplemented in ImagePage.

Definition at line 1484 of file Article.php.

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

Perform a deletion and output success or failure messages.

Parameters:

$reason
$suppress	bool

Definition at line 1696 of file Article.php.

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.

Article::doRedirect	(	$	noRedir = `false`,
		$	sectionAnchor = `''`,
		$	extraQuery = `''`
	)

Output a redirect back to the article.

This is typically used after an edit.

Deprecated:: in 1.18; call OutputPage::redirect() directly

Parameters:

	$noRedir	Boolean: add redirect=no
string	$sectionAnchor	section to redirect to, including "#"
string	$extraQuery	extra query params

Definition at line 1958 of file Article.php.

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

Parameters:

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

Returns:: array

Definition at line 2073 of file Article.php.

Article::doUnwatch ( )

Stop watching a page.

Returns:: bool true on successful unwatch

Deprecated:: since 1.18

Definition at line 1944 of file Article.php.

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

Article::doWatch ( )

Add this page to the current user's watchlist.

This is safe to be called multiple times

Returns:: bool true on successful watch operation

Deprecated:: since 1.18

Definition at line 1924 of file Article.php.

Article::fetchContent ( )

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

Access:: 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 365 of file Article.php.

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

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

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

Article::forUpdate ( )

No-op.

Deprecated:: since 1.18

Definition at line 455 of file Article.php.

Article::generateReason ( &$ hasHistory )

Parameters:

$hasHistory bool

Returns:: mixed

Definition at line 2095 of file Article.php.

static Article::getAutosummary	(	$	oldtext,
		$	newtext,
		$	flags
	)		`[static]`

Parameters:

$oldtext
$newtext
$flags

Returns:: string

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

Definition at line 2138 of file Article.php.

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.

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.

Article::getContext ( )

Gets the context this Article is executed in.

Returns:: IContextSource

Since:: 1.18

Definition at line 1852 of file Article.php.

Referenced by CategoryPage\closeShowCategory(), fetchContentObject(), protect(), showDiffPage(), and CategoryPage\view().

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.

Referenced by fetchContentObject().

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.

Article::getPage ( )

Get the WikiPage object of this instance.

Since:: 1.19

Returns:: WikiPage

Definition at line 204 of file Article.php.

Article::getParserOptions ( )

Get parser options suitable for rendering the primary article wikitext.

Returns:: ParserOptions

Definition at line 1828 of file Article.php.

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

Article::getRevIdFetched ( )

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

Returns:: int revision ID of last article revision

Definition at line 491 of file Article.php.

Article::getRevisionFetched ( )

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

Since:: 1.19

Returns:: Revision|null

Definition at line 480 of file Article.php.

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

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 EditPage\__construct(), ImageHistoryList\__construct(), CategoryPage\closeShowCategory(), fetchContentObject(), and CategoryPage\view().

Article::info ( )

Info about this page.

Deprecated:: since 1.19

Definition at line 1865 of file Article.php.

Article::isCurrent ( )

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

Returns:: bool

Definition at line 464 of file Article.php.

Article::isFileCacheable ( )

Check if the page can be cached.

Returns:: bool

Definition at line 1769 of file Article.php.

Article::loadContent ( )

Load the revision (including text) into this object.

Deprecated:: in 1.19; use fetchContent()

Definition at line 348 of file Article.php.

Article::markpatrolled ( )

Mark this particular edit/page as patrolled.

Deprecated:: since 1.18

Definition at line 1874 of file Article.php.

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.

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.

Referenced by RebuildFileCache\execute().

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.

Referenced by ApiEditPage\execute().

Article::newPage ( Title $ title ) [protected]

Parameters:

$title Title

Returns:: WikiPage

Reimplemented in ImagePage, and CategoryPage.

Definition at line 119 of file Article.php.

static Article::onArticleCreate ( $ title ) [static]

Parameters:

$title Title

Definition at line 2113 of file Article.php.

References selectFields().

static Article::onArticleDelete ( $ title ) [static]

Parameters:

$title Title

Definition at line 2120 of file Article.php.

static Article::onArticleEdit ( $ title ) [static]

Parameters:

$title Title

Definition at line 2127 of file Article.php.

Article::protect ( )

action=protect handler

Definition at line 1469 of file Article.php.

References getContext(), and view().

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

Article::render ( )

Handle action=render.

Reimplemented in ImagePage.

Definition at line 1461 of file Article.php.

Article::revert ( )

Handle action=revert.

Deprecated:: since 1.19

Definition at line 1892 of file Article.php.

Article::rollback ( )

Handle action=rollback.

Deprecated:: since 1.19

Definition at line 1901 of file Article.php.

static Article::selectFields ( ) [static]

Returns:: array

Definition at line 2106 of file Article.php.

Referenced by onArticleCreate().

Article::setContext ( $ context )

Sets the context this Article is executed in.

Parameters:

$context IContextSource

Since:: 1.18

Definition at line 1842 of file Article.php.

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

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

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.

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

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

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

References getContext().

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

Article::showNamespaceHeader ( )

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

For Article::view().

Definition at line 1011 of file Article.php.

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

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

Article::showViewFooter ( )

Show the footer section of an ordinary page view.

Definition at line 1022 of file Article.php.

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

Article::unprotect ( )

action=unprotect handler (alias)

Definition at line 1477 of file Article.php.

References $form.

Article::unwatch ( )

User interface handler for the "unwatch" action.

Requires Request to pass a token as of 1.18.

Deprecated:: since 1.18

Definition at line 1934 of file Article.php.

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

Parameters:

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

Returns:: bool

Definition at line 2042 of file Article.php.

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

Referenced by protect().

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

Article::watch ( )

User-interface handler for the "watch" action.

Requires Request to pass a token as of 1.18.

Deprecated:: since 1.18

Definition at line 1911 of file Article.php.

Member Data Documentation

string Article::$mContent

Text of the revision we are working on $mContent.

Definition at line 59 of file Article.php.

bool Article::$mContentLoaded = false

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

Definition at line 70 of file Article.php.

Content Article::$mContentObject

Content of the revision we are working on.

Since:: 1.21

Definition at line 65 of file Article.php.

IContextSource Article::$mContext [protected]

The context this Article is executed in $mContext.

{

Access:: private

Definition at line 44 of file Article.php.

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.

WikiPage Article::$mPage [protected]

The WikiPage object of this instance $mPage.

Definition at line 49 of file Article.php.

ParserOptions Article::$mParserOptions

ParserOptions object for $wgUser articles $mParserOptions.

Definition at line 54 of file Article.php.

ParserOutput Article::$mParserOutput

ParserOutput object $mParserOutput.

Definition at line 101 of file Article.php.

Title Article::$mRedirectedFrom = null

Title from which we were redirected here $mRedirectedFrom.

Definition at line 81 of file Article.php.

string false Article::$mRedirectUrl = false

URL to redirect to or false if none $mRedirectUrl.

Definition at line 86 of file Article.php.

int Article::$mRevIdFetched = 0

Revision ID of revision we are working on $mRevIdFetched.

Definition at line 91 of file Article.php.

Revision Article::$mRevision = null

Revision we are working on $mRevision.

Definition at line 96 of file Article.php.

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

Member Function Documentation

Member Data Documentation