MediaWiki  1.28.3
Article Class Reference

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

Inheritance diagram for Article:
Collaboration diagram for Article:

Public Member Functions

 __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...
 
 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 ()
 Call to WikiPage function for backwards compatibility. More...
 
 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)
 Perform a deletion and output success or failure messages. More...
 
 doDeleteArticle ($reason, $suppress=false, $u1=null, $u2=null, &$error= '')
 
 doDeleteArticleReal ($reason, $suppress=false, $u1=null, $u2=null, &$error= '', User $user=null, $tags=[])
 Call to WikiPage function for backwards compatibility. More...
 
 doDeleteUpdates ($id, Content $content=null)
 Call to WikiPage function for backwards compatibility. More...
 
 doEdit ($text, $summary, $flags=0, $baseRevId=false, $user=null)
 Call to WikiPage function for backwards compatibility. More...
 
 doEditContent (Content $content, $summary, $flags=0, $baseRevId=false, User $user=null, $serialFormat=null)
 Call to WikiPage function for backwards compatibility. More...
 
 doEditUpdates (Revision $revision, User $user, array $options=[])
 Call to WikiPage function for backwards compatibility. More...
 
 doPurge ($flags=WikiPage::PURGE_ALL)
 Call to WikiPage function for backwards compatibility. More...
 
 doRollback ($fromP, $summary, $token, $bot, &$resultDetails, User $user=null)
 
 doUpdateRestrictions (array $limit, array $expiry, &$cascade, $reason, User $user)
 
 doViewUpdates (User $user, $oldid=0)
 Call to WikiPage function for backwards compatibility. More...
 
 exists ()
 Call to WikiPage function for backwards compatibility. More...
 
 fetchContent ()
 Get text of an article from database Does NOT follow redirects. More...
 
 followRedirect ()
 Call to WikiPage function for backwards compatibility. More...
 
 generateReason (&$hasHistory)
 
 getActionOverrides ()
 Call to WikiPage function for backwards compatibility. More...
 
 getAutoDeleteReason (&$hasHistory)
 Call to WikiPage function for backwards compatibility. More...
 
 getCategories ()
 Call to WikiPage function for backwards compatibility. More...
 
 getComment ($audience=Revision::FOR_PUBLIC, User $user=null)
 Call to WikiPage function for backwards compatibility. More...
 
 getContent ()
 Note that getContent does not follow redirects anymore. More...
 
 getContentHandler ()
 Call to WikiPage function for backwards compatibility. More...
 
 getContentModel ()
 Call to WikiPage function for backwards compatibility. More...
 
 getContext ()
 Gets the context this Article is executed in. More...
 
 getContributors ()
 Call to WikiPage function for backwards compatibility. More...
 
 getCreator ($audience=Revision::FOR_PUBLIC, User $user=null)
 Call to WikiPage function for backwards compatibility. More...
 
 getDeletionUpdates (Content $content=null)
 Call to WikiPage function for backwards compatibility. More...
 
 getHiddenCategories ()
 Call to WikiPage function for backwards compatibility. More...
 
 getId ()
 Call to WikiPage function for backwards compatibility. More...
 
 getLastPurgeTimestamp ()
 Call to WikiPage function for backwards compatibility. More...
 
 getLatest ()
 Call to WikiPage function for backwards compatibility. More...
 
 getLinksTimestamp ()
 Call to WikiPage function for backwards compatibility. More...
 
 getMinorEdit ()
 Call to WikiPage function for backwards compatibility. More...
 
 getOldestRevision ()
 Call to WikiPage function for backwards compatibility. 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...
 
 getRedirectedFrom ()
 Get the page this view was redirected from. More...
 
 getRedirectTarget ()
 Call to WikiPage function for backwards compatibility. More...
 
 getRedirectURL ($rt)
 Call to WikiPage function for backwards compatibility. More...
 
 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, $pOutput=null)
 Get the robot policy to be used for the current view. More...
 
 getText ($audience=Revision::FOR_PUBLIC, User $user=null)
 Call to WikiPage function for backwards compatibility. More...
 
 getTimestamp ()
 Call to WikiPage function for backwards compatibility. More...
 
 getTitle ()
 Get the title object of the article. More...
 
 getTouched ()
 Call to WikiPage function for backwards compatibility. More...
 
 getUndoContent (Revision $undo, Revision $undoafter=null)
 Call to WikiPage function for backwards compatibility. More...
 
 getUser ($audience=Revision::FOR_PUBLIC, User $user=null)
 Call to WikiPage function for backwards compatibility. More...
 
 getUserText ($audience=Revision::FOR_PUBLIC, User $user=null)
 Call to WikiPage function for backwards compatibility. More...
 
 hasViewableContent ()
 Call to WikiPage function for backwards compatibility. More...
 
 insertOn ($dbw, $pageId=null)
 Call to WikiPage function for backwards compatibility. More...
 
 insertProtectNullRevision ($revCommentMsg, array $limit, array $expiry, $cascade, $reason, $user=null)
 Call to WikiPage function for backwards compatibility. More...
 
 insertRedirect ()
 Call to WikiPage function for backwards compatibility. More...
 
 insertRedirectEntry (Title $rt, $oldLatest=null)
 Call to WikiPage function for backwards compatibility. More...
 
 isCountable ($editInfo=false)
 Call to WikiPage function for backwards compatibility. More...
 
 isCurrent ()
 Returns true if the currently-referenced revision is the current edit to this page (and it exists). More...
 
 isFileCacheable ($mode=HTMLFileCache::MODE_NORMAL)
 Check if the page can be cached. More...
 
 isRedirect ()
 Call to WikiPage function for backwards compatibility. More...
 
 loadFromRow ($data, $from)
 Call to WikiPage function for backwards compatibility. More...
 
 loadPageData ($from= 'fromdb')
 Call to WikiPage function for backwards compatibility. More...
 
 lockAndGetLatest ()
 Call to WikiPage function for backwards compatibility. More...
 
 makeParserOptions ($context)
 Call to WikiPage function for backwards compatibility. More...
 
 pageDataFromId ($dbr, $id, $options=[])
 Call to WikiPage function for backwards compatibility. More...
 
 pageDataFromTitle ($dbr, $title, $options=[])
 Call to WikiPage function for backwards compatibility. More...
 
 prepareContentForEdit (Content $content, $revision=null, User $user=null, $serialFormat=null, $useCache=true)
 Call to WikiPage function for backwards compatibility. More...
 
 prepareTextForEdit ($text, $revid=null, User $user=null)
 Call to WikiPage function for backwards compatibility. More...
 
 protect ()
 action=protect handler More...
 
 protectDescription (array $limit, array $expiry)
 Call to WikiPage function for backwards compatibility. More...
 
 protectDescriptionLog (array $limit, array $expiry)
 Call to WikiPage function for backwards compatibility. More...
 
 render ()
 Handle action=render. More...
 
 replaceSectionAtRev ($sectionId, Content $sectionContent, $sectionTitle= '', $baseRevId=null)
 Call to WikiPage function for backwards compatibility. More...
 
 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)
 Call to WikiPage function for backwards compatibility. More...
 
 shouldCheckParserCache (ParserOptions $parserOptions, $oldId)
 Call to WikiPage function for backwards compatibility. More...
 
 showDeletedRevisionHeader ()
 If the revision requested for view is deleted, check permissions. More...
 
 showMissingArticle ()
 Show the error text for a missing article. More...
 
 showNamespaceHeader ()
 Show a header specific to the namespace currently being viewed, like [[MediaWiki:Talkpagetext]]. More...
 
 showPatrolFooter ()
 If patrol is possible, output a patrol UI box. More...
 
 showRedirectedFromHeader ()
 If this request is a redirect view, send "redirected from" subtitle to the output. More...
 
 showViewFooter ()
 Show the footer section of an ordinary page view. More...
 
 supportsSections ()
 Call to WikiPage function for backwards compatibility. More...
 
 triggerOpportunisticLinksUpdate (ParserOutput $parserOutput)
 Call to WikiPage function for backwards compatibility. More...
 
 unprotect ()
 action=unprotect handler (alias) More...
 
 updateCategoryCounts (array $added, array $deleted, $id=0)
 Call to WikiPage function for backwards compatibility. More...
 
 updateIfNewerOn ($dbw, $revision)
 Call to WikiPage function for backwards compatibility. More...
 
 updateRedirectOn ($dbw, $redirectTitle, $lastRevIsRedirect=null)
 Call to WikiPage function for backwards compatibility. More...
 
 updateRestrictions ($limit=[], $reason= '', &$cascade=0, $expiry=[])
 
 updateRevisionOn ($dbw, $revision, $lastRevision=null, $lastRevIsRedirect=null)
 Call to WikiPage function for backwards compatibility. More...
 
 view ()
 This is the default action of the index.php entry point: just view the page of the given title. More...
 
 viewRedirect ($target, $appendSubtitle=true, $forceKnown=false)
 Return the HTML for the top of a redirect page. More...
 

Static Public Member Functions

static formatRobotPolicy ($policy)
 Converts a String robot policy into an associative array, to allow merging of several policies using array_merge(). More...
 
static getAutosummary ($oldtext, $newtext, $flags)
 
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 onArticleCreate ($title)
 
static onArticleDelete ($title)
 
static onArticleEdit ($title)
 
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...
 
static selectFields ()
 

Public Attributes

string $mContent
 Text of the revision we are working on. More...
 
bool $mContentLoaded = false
 Is the content ($mContent) already loaded? More...
 
Content $mContentObject
 Content of the revision we are working on. More...
 
int null $mOldId
 The oldid of the article that is to be shown, 0 for the current revision. More...
 
ParserOptions $mParserOptions
 ParserOptions object for $wgUser articles. More...
 
ParserOutput $mParserOutput
 
Title $mRedirectedFrom = null
 Title from which we were redirected here. More...
 
string bool $mRedirectUrl = false
 URL to redirect to or false if none. More...
 
int $mRevIdFetched = 0
 Revision ID of revision we are working on. More...
 
Revision $mRevision = null
 Revision we are working on. 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...
 
 newPage (Title $title)
 
 showCssOrJsPage ($showCacheHint=true)
 Show a page view for a page formatted as CSS or JavaScript. More...
 
 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

IContextSource $mContext
 The context this Article is executed in. More...
 
WikiPage $mPage
 The WikiPage object of this instance. 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 34 of file Article.php.

Constructor & Destructor Documentation

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

Constructor and clear the article.

Parameters
Title$titleReference to a Title object.
int$oldIdRevision ID, null to fetch from request, zero for current

Definition at line 82 of file Article.php.

References newPage().

Member Function Documentation

Article::__get (   $fname)

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

Parameters
string$fnameField name
Returns
mixed

Definition at line 2051 of file Article.php.

References $fname.

Article::__set (   $fname,
  $fvalue 
)

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

Parameters
string$fnameField name
mixed$fvalueNew value

Definition at line 2066 of file Article.php.

References $fname.

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$toTarget MediaWiki.org page title or encoded URL.
bool$overrideBaseUrlWhether $url is a full URL, to avoid MW.o.
Since
1.25

Definition at line 1587 of file Article.php.

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

Referenced by CategoryPage\closeShowCategory().

Article::adjustDisplayTitle ( ParserOutput  $pOutput)

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

Parameters
ParserOutput$pOutput

Definition at line 727 of file Article.php.

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

Referenced by view().

Article::checkFlags (   $flags)

Call to WikiPage function for backwards compatibility.

See also
WikiPage::checkFlags

Definition at line 2082 of file Article.php.

References $flags.

Article::checkTouched ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::checkTouched

Definition at line 2090 of file Article.php.

Article::clear ( )

Clear the object.

Definition at line 190 of file Article.php.

References set.

Article::clearPreparedEdit ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::clearPreparedEdit

Definition at line 2098 of file Article.php.

Article::commitRollback (   $fromP,
  $summary,
  $bot,
$resultDetails,
User  $guser = null 
)
Parameters
string$fromP
string$summary
bool$bot
array$resultDetails
User | null$guser
Returns
array

Definition at line 2696 of file Article.php.

References $summary, and getContext().

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

Perform a deletion and output success or failure messages.

Parameters
string$reason
bool$suppress

Definition at line 1867 of file Article.php.

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

Referenced by delete().

Article::doDeleteArticle (   $reason,
  $suppress = false,
  $u1 = null,
  $u2 = null,
$error = '' 
)
Parameters
string$reason
bool$suppress
int$u1Unused
bool$u2Unused
string$error
Returns
bool

Definition at line 2668 of file Article.php.

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::doDeleteArticleReal

Definition at line 2106 of file Article.php.

References $user.

Article::doDeleteUpdates (   $id,
Content  $content = null 
)

Call to WikiPage function for backwards compatibility.

See also
WikiPage::doDeleteUpdates

Definition at line 2119 of file Article.php.

References $content.

Article::doEdit (   $text,
  $summary,
  $flags = 0,
  $baseRevId = false,
  $user = null 
)

Call to WikiPage function for backwards compatibility.

See also
WikiPage::doEdit
Deprecated:
since 1.21: use doEditContent() instead.

Definition at line 2129 of file Article.php.

References $flags, $summary, $user, and wfDeprecated().

Article::doEditContent ( Content  $content,
  $summary,
  $flags = 0,
  $baseRevId = false,
User  $user = null,
  $serialFormat = null 
)

Call to WikiPage function for backwards compatibility.

See also
WikiPage::doEditContent

Definition at line 2138 of file Article.php.

References $flags, $summary, and $user.

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::doEditUpdates

Definition at line 2150 of file Article.php.

References $options.

Article::doPurge (   $flags = WikiPage::PURGE_ALL)

Call to WikiPage function for backwards compatibility.

See also
WikiPage::doPurge

Definition at line 2158 of file Article.php.

References $flags.

Article::doRollback (   $fromP,
  $summary,
  $token,
  $bot,
$resultDetails,
User  $user = null 
)
Parameters
string$fromP
string$summary
string$token
bool$bot
array$resultDetails
User | null$user
Returns
array

Definition at line 2683 of file Article.php.

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

Article::doUpdateRestrictions ( array  $limit,
array  $expiry,
$cascade,
  $reason,
User  $user 
)
Parameters
array$limit
array$expiry
bool$cascade
string$reason
User$user
Returns
Status

Definition at line 2635 of file Article.php.

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::doViewUpdates

Definition at line 2174 of file Article.php.

Article::exists ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::exists

Definition at line 2182 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
string|bool String containing article contents, or false if null
Deprecated:
since 1.21, use WikiPage::getContent() instead

Definition at line 333 of file Article.php.

References $content, $mContent, fetchContentObject(), ContentHandler\getContentText(), ContentHandler\runLegacyHooks(), and wfDeprecated().

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|bool
Since
1.21

Definition at line 371 of file Article.php.

References $content, $mContentObject, Revision\FOR_THIS_USER, getContext(), getOldID(), getTitle(), getUser(), Revision\newFromId(), Hooks\run(), and wfDebug().

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

Article::followRedirect ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::followRedirect

Definition at line 2190 of file Article.php.

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$policyReturns empty array on null/false/'', transparent to already-converted arrays, converts string.
Returns
array 'index' => \<indexpolicy\>, 'follow' => \<followpolicy\>

Definition at line 911 of file Article.php.

References as.

Referenced by OutputPage\setRobotPolicy().

Article::generateReason ( $hasHistory)
Parameters
bool$hasHistory
Returns
mixed

Definition at line 2705 of file Article.php.

References $handler, $title, and ContentHandler\getForTitle().

Referenced by delete().

Article::getActionOverrides ( )

Call to WikiPage function for backwards compatibility.

See also
ContentHandler::getActionOverrides

Definition at line 2198 of file Article.php.

Article::getAutoDeleteReason ( $hasHistory)

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getAutoDeleteReason

Definition at line 2206 of file Article.php.

static Article::getAutosummary (   $oldtext,
  $newtext,
  $flags 
)
static
Parameters
string$oldtext
string$newtext
int$flags
Returns
string
Deprecated:
since 1.21, use ContentHandler::getAutosummary() instead

Definition at line 2758 of file Article.php.

References $flags, and WikiPage\getAutosummary().

Referenced by ArticleTest\testStaticFunctions().

Article::getCategories ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getCategories

Definition at line 2214 of file Article.php.

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getComment

Definition at line 2222 of file Article.php.

References $user.

Article::getContent ( )

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.21; use WikiPage::getContent() instead
Returns
string Return the text of this revision

Definition at line 212 of file Article.php.

References $content, getContentObject(), ContentHandler\getContentText(), and wfDeprecated().

Article::getContentHandler ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getContentHandler

Definition at line 2230 of file Article.php.

Article::getContentModel ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getContentModel

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

Returns
Content Return the content of this revision
Since
1.21

Definition at line 233 of file Article.php.

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

Referenced by getContent(), showMissingArticle(), and view().

Article::getContributors ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getContributors

Definition at line 2246 of file Article.php.

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getCreator

Definition at line 2254 of file Article.php.

References $user.

Article::getDeletionUpdates ( Content  $content = null)

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getDeletionUpdates

Definition at line 2262 of file Article.php.

References $content.

Article::getHiddenCategories ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getHiddenCategories

Definition at line 2270 of file Article.php.

Article::getId ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getId

Definition at line 2278 of file Article.php.

Referenced by ImagePage\getContentObject(), and ImagePage\openShowImage().

Article::getLastPurgeTimestamp ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getLastPurgeTimestamp

Definition at line 2166 of file Article.php.

Article::getLatest ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getLatest

Definition at line 2286 of file Article.php.

Article::getLinksTimestamp ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getLinksTimestamp

Definition at line 2294 of file Article.php.

Article::getMinorEdit ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getMinorEdit

Definition at line 2302 of file Article.php.

Article::getOldestRevision ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getOldestRevision

Definition at line 2310 of file Article.php.

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

Definition at line 260 of file Article.php.

References $mOldId, and getOldIDFromRequest().

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

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

References $request, getContext(), getTitle(), and Revision\newFromId().

Referenced by getOldID().

Article::getPage ( )

Get the WikiPage object of this instance.

Since
1.19
Returns
WikiPage

Definition at line 183 of file Article.php.

References $mPage.

Referenced by ImageHistoryList\__construct(), EditPage\__construct(), and view().

Article::getParserOptions ( )

Get parser options suitable for rendering the primary article wikitext.

Returns
ParserOptions

Definition at line 2010 of file Article.php.

References $mParserOptions, and getContext().

Referenced by getParserOutput(), and view().

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
int | null$oldidRevision ID or null
User$userThe relevant user
Returns
ParserOutput|bool ParserOutput or false if the given revision ID is not found

Definition at line 1979 of file Article.php.

References $user, and getParserOptions().

Referenced by showMissingArticle().

Article::getRedirectedFrom ( )

Get the page this view was redirected from.

Returns
Title|null
Since
1.28

Definition at line 155 of file Article.php.

References $mRedirectedFrom.

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 | array$targetDestination(s) to redirect
bool$forceKnownShould the image be shown as a bluelink regardless of existence?
Returns
string Containing HTML with redirect link

Definition at line 1552 of file Article.php.

References $html, $title, as, Linker\link(), and wfMessage().

Referenced by WikitextContent\fillParserOutput().

Article::getRedirectTarget ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getRedirectTarget

Definition at line 2318 of file Article.php.

Article::getRedirectURL (   $rt)

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getRedirectURL

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

References $mRevIdFetched.

Referenced by view().

Article::getRevision ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getRevision

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

References $mRevision, and fetchContentObject().

Referenced by showDiffPage().

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

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

Parameters
string$actionThe action= GET parameter
ParserOutput | null$pOutput
Returns
array The policy that should be set
Todo:
actions other than 'view'

Definition at line 831 of file Article.php.

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

Referenced by showMissingArticle(), and view().

Article::getText (   $audience = Revision::FOR_PUBLIC,
User  $user = null 
)

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getText
Deprecated:
since 1.21 use WikiPage::getContent() instead

Definition at line 2343 of file Article.php.

References $user, and wfDeprecated().

Referenced by showViewFooter().

Article::getTimestamp ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getTimestamp

Definition at line 2352 of file Article.php.

Article::getTouched ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getTouched

Definition at line 2360 of file Article.php.

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getUndoContent

Definition at line 2368 of file Article.php.

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getUser

Definition at line 2376 of file Article.php.

References $user.

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

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::getUserText

Definition at line 2384 of file Article.php.

References $user.

Article::hasViewableContent ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::hasViewableContent

Definition at line 2392 of file Article.php.

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::insertOn

Definition at line 2400 of file Article.php.

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::insertProtectNullRevision

Definition at line 2408 of file Article.php.

References $user.

Article::insertRedirect ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::insertRedirect

Definition at line 2420 of file Article.php.

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::insertRedirectEntry

Definition at line 2428 of file Article.php.

Article::isCountable (   $editInfo = false)

Call to WikiPage function for backwards compatibility.

See also
WikiPage::isCountable

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

References getOldID().

Referenced by view().

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

Check if the page can be cached.

Parameters
integer$modeOne of the HTMLFileCache::MODE_* constants (since 1.28)
Returns
bool

Definition at line 1951 of file Article.php.

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

Referenced by tryFileCache().

Article::isRedirect ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::isRedirect

Definition at line 2444 of file Article.php.

Referenced by showRedirectedFromHeader().

Article::loadFromRow (   $data,
  $from 
)

Call to WikiPage function for backwards compatibility.

See also
WikiPage::loadFromRow

Definition at line 2452 of file Article.php.

References $from.

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::loadPageData

Definition at line 2460 of file Article.php.

References $from.

Article::lockAndGetLatest ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::lockAndGetLatest

Definition at line 2468 of file Article.php.

Article::makeParserOptions (   $context)

Call to WikiPage function for backwards compatibility.

See also
WikiPage::makeParserOptions

Definition at line 2476 of file Article.php.

References $context.

static Article::newFromID (   $id)
static

Constructor from a page id.

Parameters
int$idArticle ID to load
Returns
Article|null

Definition at line 100 of file Article.php.

References $t, and Title\newFromID().

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

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

Referenced by ApiParse\execute(), and RebuildFileCache\execute().

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

References $article, $context, $page, and WikiPage\getTitle().

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

Article::newPage ( Title  $title)
protected
Parameters
Title$title
Returns
WikiPage

Definition at line 91 of file Article.php.

Referenced by __construct().

static Article::onArticleCreate (   $title)
static
Parameters
Title$title
Deprecated:
since 1.24, use WikiPage::onArticleCreate() instead

Definition at line 2726 of file Article.php.

References $title, WikiPage\onArticleCreate(), and wfDeprecated().

static Article::onArticleDelete (   $title)
static
Parameters
Title$title
Deprecated:
since 1.24, use WikiPage::onArticleDelete() instead

Definition at line 2736 of file Article.php.

References $title, WikiPage\onArticleDelete(), and wfDeprecated().

static Article::onArticleEdit (   $title)
static
Parameters
Title$title
Deprecated:
since 1.24, use WikiPage::onArticleEdit() instead

Definition at line 2746 of file Article.php.

References $title, WikiPage\onArticleEdit(), and wfDeprecated().

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::pageDataFromId

Definition at line 2484 of file Article.php.

References $dbr, and $options.

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::pageDataFromTitle

Definition at line 2492 of file Article.php.

References $dbr, $options, and $title.

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::prepareContentForEdit

Definition at line 2500 of file Article.php.

References $user.

Article::prepareTextForEdit (   $text,
  $revid = null,
User  $user = null 
)

Call to WikiPage function for backwards compatibility.

Deprecated:
since 1.21, use prepareContentForEdit
See also
WikiPage::prepareTextForEdit

Definition at line 2515 of file Article.php.

References $user.

Article::protect ( )

action=protect handler

Definition at line 1614 of file Article.php.

Referenced by unprotect().

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::protectDescription

Definition at line 2523 of file Article.php.

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::protectDescriptionLog

Definition at line 2531 of file Article.php.

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$articleIDID of the article to purge
Since
1.27

Definition at line 1221 of file Article.php.

References $cache, ObjectCache\getMainWANInstance(), and wfMemcKey().

Referenced by LocalFile\recordUpload2().

Article::render ( )

Handle action=render.

Definition at line 1604 of file Article.php.

References getContext(), and view().

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::replaceSectionAtRev

Definition at line 2539 of file Article.php.

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::replaceSectionContent

Definition at line 2551 of file Article.php.

static Article::selectFields ( )
static
Returns
array
Deprecated:
since 1.24, use WikiPage::selectFields() instead

Definition at line 2716 of file Article.php.

References WikiPage\selectFields(), and wfDeprecated().

Referenced by ArticleTest\testStaticFunctions().

Article::setContext (   $context)

Sets the context this Article is executed in.

Parameters
IContextSource$context
Since
1.18

Definition at line 2024 of file Article.php.

References $context.

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$oldidRevision ID of this article revision

Definition at line 1395 of file Article.php.

References $context, $mRevision, $nextlink, $timestamp, $unhide, $user, getContext(), Linker\getRevDeleteLink(), getTitle(), Linker\linkKnown(), Revision\newFromId(), Linker\revComment(), Linker\revUserTools(), and Hooks\run().

Referenced by view().

Article::setParserOptions ( ParserOptions  $options)

Override the ParserOptions used to render the primary article wikitext.

Parameters
ParserOptions$options
Exceptions
MWExceptionIf the parser options where already initialized.

Definition at line 1997 of file Article.php.

References $options.

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

References $from.

Article::setTimestamp (   $ts)

Call to WikiPage function for backwards compatibility.

See also
WikiPage::setTimestamp

Definition at line 2563 of file Article.php.

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::shouldCheckParserCache

Definition at line 2571 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 exists mostly to serve the deprecated ShowRawCssJs hook (used to customize these views). It has been replaced by the ContentGetParserOutput hook, which lets you do the same but with more flexibility.

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

Definition at line 794 of file Article.php.

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

Referenced by view().

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

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

Referenced by view().

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

References $request, $rev, $unhide, $user, getContext(), getOldID(), getRevisionFetched(), list, and wfMessage().

Referenced by view().

Article::showNamespaceHeader ( )

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

For Article::view().

Definition at line 1014 of file Article.php.

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

Referenced by view().

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

References $cache, $dbr, $link, $title, $user, DB_REPLICA, getContext(), ObjectCache\getMainWANInstance(), getTitle(), global, RecentChange\isInRCLifespan(), Linker\linkKnown(), RecentChange\newFromConds(), NS_FILE, RC_LOG, wfGetDB(), wfMemcKey(), and wfMessage().

Referenced by showViewFooter().

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

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

Referenced by view().

Article::showViewFooter ( )

Show the footer section of an ordinary page view.

Definition at line 1028 of file Article.php.

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

Referenced by view().

Article::supportsSections ( )

Call to WikiPage function for backwards compatibility.

See also
WikiPage::supportsSections

Definition at line 2579 of file Article.php.

Article::triggerOpportunisticLinksUpdate ( ParserOutput  $parserOutput)

Call to WikiPage function for backwards compatibility.

See also
WikiPage::triggerOpportunisticLinksUpdate

Definition at line 2587 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
bool True if cached version send, false otherwise

Definition at line 1920 of file Article.php.

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

Referenced by view().

Article::unprotect ( )

action=unprotect handler (alias)

Definition at line 1622 of file Article.php.

References protect().

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::updateCategoryCounts

Definition at line 2595 of file Article.php.

Article::updateIfNewerOn (   $dbw,
  $revision 
)

Call to WikiPage function for backwards compatibility.

See also
WikiPage::updateIfNewerOn

Definition at line 2603 of file Article.php.

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::updateRedirectOn

Definition at line 2611 of file Article.php.

Article::updateRestrictions (   $limit = [],
  $reason = '',
$cascade = 0,
  $expiry = [] 
)
Parameters
array$limit
string$reason
int$cascade
array$expiry
Returns
bool

Definition at line 2648 of file Article.php.

References $limit, getContext(), and getUser().

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

Call to WikiPage function for backwards compatibility.

See also
WikiPage::updateRevisionOn

Definition at line 2619 of file Article.php.

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$targetDestination(s) to redirect
bool$appendSubtitle[optional]
bool$forceKnownShould the image be shown as a bluelink regardless of existence?
Returns
string Containing HTML with redirect link

Definition at line 1530 of file Article.php.

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

Referenced by ImagePage\view().

Member Data Documentation

string Article::$mContent

Text of the revision we are working on.

Todo:
BC cruft

Definition at line 48 of file Article.php.

Referenced by fetchContent().

bool Article::$mContentLoaded = false

Is the content ($mContent) already loaded?

Definition at line 57 of file Article.php.

Content Article::$mContentObject

Content of the revision we are working on.

Since
1.21

Definition at line 54 of file Article.php.

Referenced by fetchContentObject(), and getContentObject().

IContextSource Article::$mContext
protected

The context this Article is executed in.

Definition at line 36 of file Article.php.

Referenced by getContext().

int null Article::$mOldId

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

Definition at line 60 of file Article.php.

Referenced by getOldID().

WikiPage Article::$mPage
protected

The WikiPage object of this instance.

Definition at line 39 of file Article.php.

Referenced by getPage().

ParserOptions Article::$mParserOptions

ParserOptions object for $wgUser articles.

Definition at line 42 of file Article.php.

Referenced by getParserOptions().

ParserOutput Article::$mParserOutput

Definition at line 75 of file Article.php.

Title Article::$mRedirectedFrom = null

Title from which we were redirected here.

Definition at line 63 of file Article.php.

Referenced by getRedirectedFrom().

string bool Article::$mRedirectUrl = false

URL to redirect to or false if none.

Definition at line 66 of file Article.php.

int Article::$mRevIdFetched = 0

Revision ID of revision we are working on.

Definition at line 69 of file Article.php.

Referenced by getRevIdFetched().

Revision Article::$mRevision = null

Revision we are working on.

Definition at line 72 of file Article.php.

Referenced by getRevisionFetched(), and setOldSubtitle().


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