MediaWiki  master
Article Class Reference

Legacy class representing an editable page and handling UI for some page actions. More...

Inheritance diagram for Article:
Collaboration diagram for Article:

Public Member Functions

 __construct (Title $title, $oldId=null)
 
 __get ( $fname)
 
 __set ( $fname, $fvalue)
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 adjustDisplayTitle (ParserOutput $pOutput)
 Adjust title for pages with displaytitle, -{T|}- or language conversion. More...
 
 clear ()
 
 doDelete ( $reason, $suppress=false, $immediate=false)
 Perform a deletion and output success or failure messages. More...
 
 fetchRevisionRecord ()
 Fetches the revision to work on. More...
 
 getActionOverrides ()
 Call to WikiPage function for backwards compatibility. More...
 
 getContext ()
 Gets the context this Article is executed in. More...
 
 getOldID ()
 
 getOldIDFromRequest ()
 Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect. More...
 
 getPage ()
 Get the WikiPage object of this instance. More...
 
 getParserOptions ()
 Get parser options suitable for rendering the primary article wikitext. More...
 
 getParserOutput ( $oldid=null, UserIdentity $user=null)
 #- More...
 
 getRedirectedFrom ()
 Get the page this view was redirected from. More...
 
 getRevIdFetched ()
 Use this to fetch the rev ID used on page views. More...
 
 getRobotPolicy ( $action, ParserOutput $pOutput=null)
 Get the robot policy to be used for the current view. More...
 
 getTimestamp ()
 
 getTitle ()
 Get the title object of the article. More...
 
 isCurrent ()
 Returns true if the currently-referenced revision is the current edit to this page (and it exists). More...
 
 isFileCacheable ( $mode=HTMLFileCache::MODE_NORMAL)
 Check if the page can be cached. More...
 
 protect ()
 action=protect handler More...
 
 render ()
 Handle action=render. More...
 
 setContext ( $context)
 Sets the context this Article is executed in. More...
 
 setOldSubtitle ( $oldid=0)
 Generate the navigation links when browsing through an article revisions It shows the information as: Revision as of \<date\>; view current revision \<- Previous version | Next Version -\> More...
 
 setRedirectedFrom (Title $from)
 Tell the page view functions that this view was redirected from another page on the wiki. More...
 
 showDeletedRevisionHeader ()
 If the revision requested for view is deleted, check permissions. More...
 
 showMissingArticle ()
 Show the error text for a missing article. More...
 
 showNamespaceHeader ()
 Show a header specific to the namespace currently being viewed, like [[MediaWiki:Talkpagetext]]. More...
 
 showPatrolFooter ()
 If patrol is possible, output a patrol UI box. More...
 
 showRedirectedFromHeader ()
 If this request is a redirect view, send "redirected from" subtitle to the output. More...
 
 showViewFooter ()
 Show the footer section of an ordinary page view. More...
 
 unprotect ()
 action=unprotect handler (alias) More...
 
 view ()
 This is the default action of the index.php entry point: just view the page of the given title. More...
 
 viewRedirect ( $target, $appendSubtitle=true, $forceKnown=false)
 Return the HTML for the top of a redirect page. More...
 

Static Public Member Functions

static formatRobotPolicy ( $policy)
 Converts a String robot policy into an associative array, to allow merging of several policies using array_merge(). More...
 
static getRedirectHeaderHtml (Language $lang, $target, $forceKnown=false)
 Return the HTML for the top of a redirect page. More...
 
static newFromID ( $id)
 Constructor from a page id. More...
 
static newFromTitle ( $title, IContextSource $context)
 Create an Article object of the appropriate class for the given page. More...
 
static newFromWikiPage (WikiPage $page, IContextSource $context)
 Create an Article object of the appropriate class for the given page. More...
 
static purgePatrolFooterCache ( $articleID)
 Purge the cache used to check if it is worth showing the patrol footer For example, it is done during re-uploads when file patrol is used. More...
 

Public Attributes

int null $mOldId
 The oldid of the article that was requested to be shown, 0 for the current revision. More...
 
ParserOutput null false $mParserOutput = null
 The ParserOutput generated for viewing the page, initialized by view(). More...
 
Title null $mRedirectedFrom = null
 Title from which we were redirected here, if any. More...
 
string bool $mRedirectUrl = false
 URL to redirect to or false if none. More...
 

Protected Member Functions

 isDiffOnlyView ()
 
 newPage (Title $title)
 
 showDiffPage ()
 Show a diff page according to current request variables. More...
 
 tryFileCache ()
 checkLastModified returns true if it has taken care of all output to the client that is necessary for this request. More...
 

Protected Attributes

LinkRenderer $linkRenderer
 
IContextSource null $mContext
 The context this Article is executed in. More...
 
WikiPage $mPage
 The WikiPage object of this instance. More...
 
bool $viewIsRenderAction = false
 Whether render() was called. More...
 

Detailed Description

Legacy class representing an editable page and handling UI for some page actions.

This has largely been superseded by WikiPage, with Action subclasses for the user interface of page actions, and service classes for their backend logic.

Todo:

Move and refactor remaining code

Deprecate

Definition at line 48 of file Article.php.

Constructor & Destructor Documentation

◆ __construct()

Article::__construct ( Title  $title,
  $oldId = null 
)
Parameters
Title$title
int | null$oldIdRevision ID, null to fetch from request, zero for current

Definition at line 131 of file Article.php.

References newPage().

Member Function Documentation

◆ __get()

Article::__get (   $fname)
Deprecated:
since 1.35, use Article::getPage() instead

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

Parameters
string$fnameField name
Returns
mixed

Definition at line 2025 of file Article.php.

References wfDeprecatedMsg().

◆ __set()

Article::__set (   $fname,
  $fvalue 
)
Deprecated:
since 1.35, use Article::getPage() instead

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

Parameters
string$fnameField name
mixed$fvalueNew value

Definition at line 2044 of file Article.php.

References wfDeprecatedMsg().

◆ addHelpLink()

Article::addHelpLink (   $to,
  $overrideBaseUrl = false 
)

Adds help link with an icon via page indicators.

Link target can be overridden by a local message containing a wikilink: the message key is: 'namespace-' + namespace number + '-helppage'.

Parameters
string$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 1800 of file Article.php.

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

Referenced by CategoryPage\closeShowCategory().

◆ adjustDisplayTitle()

Article::adjustDisplayTitle ( ParserOutput  $pOutput)

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

Parameters
ParserOutput$pOutput

Definition at line 839 of file Article.php.

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

◆ clear()

Article::clear ( )

Definition at line 244 of file Article.php.

◆ doDelete()

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

Perform a deletion and output success or failure messages.

Deprecated:
since 1.37, hard deprecated since 1.38. Use WikiPage::doDeleteArticleReal if you only need to delete the article. If you also need things to happen with OutputPage, you may want to check the hooks in DeleteAction instead.
Parameters
string$reason
bool$suppress
bool$immediatefalse allows deleting over time via the job queue
Exceptions
FatalError
MWException

Definition at line 1853 of file Article.php.

References OutputPage\addHTML(), OutputPage\addWikiMsg(), Xml\element(), getContext(), ContextSource\getOutput(), getTitle(), OutputPage\returnToMain(), OutputPage\setPageTitle(), OutputPage\setRobotPolicy(), LogEventsList\showLogExtract(), wfDeprecated(), wfEscapeWikiText(), and OutputPage\wrapWikiTextAsInterface().

◆ fetchRevisionRecord()

Article::fetchRevisionRecord ( )

Fetches the revision to work on.

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

Public since 1.35

Returns
RevisionRecord|null

Definition at line 344 of file Article.php.

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

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

Definition at line 1008 of file Article.php.

Referenced by OutputPage\setRobotPolicy().

◆ getActionOverrides()

Article::getActionOverrides ( )

Call to WikiPage function for backwards compatibility.

See also
ContentHandler::getActionOverrides
Returns
array

Definition at line 2063 of file Article.php.

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

◆ getContext()

◆ getOldID()

Article::getOldID ( )
See also
getOldIDFromRequest()
getRevIdFetched()
Returns
int The oldid of the article that is was requested in the constructor or via the context's WebRequest.

Definition at line 262 of file Article.php.

References $mOldId, and getOldIDFromRequest().

Referenced by fetchRevisionRecord(), isCurrent(), 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 275 of file Article.php.

References getContext(), and getTitle().

Referenced by getOldID().

◆ getPage()

◆ getParserOptions()

Article::getParserOptions ( )

Get parser options suitable for rendering the primary article wikitext.

Returns
ParserOptions

Definition at line 1986 of file Article.php.

References getContext().

Referenced by view().

◆ getParserOutput()

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

#-

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

Since
1.16 (r52326) for LiquidThreads
Parameters
int | null$oldidRevision ID or null
UserIdentity | null$userThe relevant user
Returns
ParserOutput|bool ParserOutput or false if the given revision ID is not found

Definition at line 1972 of file Article.php.

◆ getRedirectedFrom()

Article::getRedirectedFrom ( )

Get the page this view was redirected from.

Returns
Title|null
Since
1.28

Definition at line 212 of file Article.php.

References $mRedirectedFrom.

◆ getRedirectHeaderHtml()

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

Return the HTML for the top of a redirect page.

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

Since
1.23
Parameters
Language$lang
Title$targetDestination to redirect
bool$forceKnownShould the image be shown as a bluelink regardless of existence?
Returns
string Containing HTML with redirect link

Definition at line 1754 of file Article.php.

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

Referenced by WikitextContentHandler\fillParserOutput().

◆ getRevIdFetched()

Article::getRevIdFetched ( )

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

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

Returns
int Revision ID of last article revision

Definition at line 421 of file Article.php.

Referenced by view().

◆ getRobotPolicy()

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

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

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

Definition at line 924 of file Article.php.

References $title, getContext(), ParserOutput\getIndexPolicy(), getTitle(), NS_USER, and NS_USER_TALK.

◆ getTimestamp()

Article::getTimestamp ( )
Deprecated:
since 1.35, use WikiPage::getTimestamp instead
See also
WikiPage::getTimestamp
Returns
string

Definition at line 2072 of file Article.php.

References wfDeprecated().

◆ getTitle()

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

References getOldID().

Referenced by view().

◆ isDiffOnlyView()

Article::isDiffOnlyView ( )
protected

Definition at line 910 of file Article.php.

References getContext().

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

◆ isFileCacheable()

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

Check if the page can be cached.

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

Definition at line 1944 of file Article.php.

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

◆ newFromID()

static Article::newFromID (   $id)
static

Constructor from a page id.

Parameters
int$idArticle ID to load
Returns
Article|null

Definition at line 156 of file Article.php.

References $t, and Title\newFromID().

◆ newFromTitle()

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

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

Parameters
Title$title
IContextSource$context
Returns
Article

Definition at line 168 of file Article.php.

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

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

◆ newFromWikiPage()

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

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

Parameters
WikiPage$page
IContextSource$context
Returns
Article

Definition at line 201 of file Article.php.

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

Referenced by ApiEditPage\execute().

◆ newPage()

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

Reimplemented in ImagePage, and CategoryPage.

Definition at line 147 of file Article.php.

References $title.

Referenced by __construct().

◆ protect()

Article::protect ( )

action=protect handler

Definition at line 1828 of file Article.php.

◆ purgePatrolFooterCache()

static Article::purgePatrolFooterCache (   $articleID)
static

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

Parameters
int$articleIDID of the article to purge
Since
1.27

Definition at line 1318 of file Article.php.

References $cache.

◆ render()

Article::render ( )

Handle action=render.

Definition at line 1817 of file Article.php.

References getContext().

◆ setContext()

Article::setContext (   $context)

Sets the context this Article is executed in.

Parameters
IContextSource$context
Since
1.18

Definition at line 1996 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$oldidRevision ID of this article revision

Definition at line 1566 of file Article.php.

References OutputPage\addModuleStyles(), OutputPage\addSubtitle(), getContext(), ContextSource\getOutput(), Linker\getRevDeleteLink(), getTitle(), Linker\revComment(), Linker\revUserTools(), and Html\warningBox().

◆ setRedirectedFrom()

Article::setRedirectedFrom ( Title  $from)

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

Parameters
Title$from

Definition at line 221 of file Article.php.

◆ showDeletedRevisionHeader()

Article::showDeletedRevisionHeader ( )

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

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

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

Definition at line 1506 of file Article.php.

References getContext(), getTitle(), ContextSource\msg(), and Html\warningBox().

◆ showDiffPage()

Article::showDiffPage ( )
protected

Show a diff page according to current request variables.

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

Definition at line 854 of file Article.php.

References getContext(), and MediaWiki\Revision\RevisionRecord\getSlot().

Referenced by view().

◆ showMissingArticle()

◆ showNamespaceHeader()

Article::showNamespaceHeader ( )

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

For Article::view().

Definition at line 1108 of file Article.php.

References getContext(), and getTitle().

Referenced by view().

◆ showPatrolFooter()

Article::showPatrolFooter ( )

If patrol is possible, output a patrol UI box.

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

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

Returns
bool

Definition at line 1144 of file Article.php.

References $cache, $dbr, $title, OutputPage\addHTML(), OutputPage\addModules(), OutputPage\addModuleStyles(), DB_REPLICA, getContext(), ContextSource\getOutput(), getTitle(), RecentChange\isInRCLifespan(), RecentChange\newFromConds(), NS_FILE, RC_LOG, OutputPage\setPreventClickjacking(), and wfGetDB().

◆ showRedirectedFromHeader()

Article::showRedirectedFromHeader ( )

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

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

Returns
bool

Definition at line 1035 of file Article.php.

References OutputPage\addJsConfigVars(), OutputPage\addModules(), OutputPage\addSubtitle(), getContext(), ContextSource\getOutput(), getTitle(), Linker\makeExternalLink(), OutputPage\setCanonicalUrl(), and OutputPage\setRedirectedFrom().

Referenced by view().

◆ showViewFooter()

Article::showViewFooter ( )

Show the footer section of an ordinary page view.

Definition at line 1120 of file Article.php.

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

Referenced by view().

◆ tryFileCache()

Article::tryFileCache ( )
protected

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

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

Returns
bool True if cached version send, false otherwise

Definition at line 1913 of file Article.php.

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

Referenced by view().

◆ unprotect()

Article::unprotect ( )

action=unprotect handler (alias)

Definition at line 1836 of file Article.php.

◆ view()

Article::view ( )

◆ viewRedirect()

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

Return the HTML for the top of a redirect page.

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

Parameters
Title | array$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
Deprecated:
since 1.30, hard-deprecated since 1.39

Definition at line 1731 of file Article.php.

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

Member Data Documentation

◆ $linkRenderer

LinkRenderer Article::$linkRenderer
protected

Definition at line 97 of file Article.php.

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

◆ $mContext

IContextSource null Article::$mContext
protected

The context this Article is executed in.

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

Deprecated:
since 1.35, must be private, use getContext

Definition at line 57 of file Article.php.

◆ $mOldId

int null Article::$mOldId

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

Definition at line 66 of file Article.php.

Referenced by getOldID().

◆ $mPage

WikiPage Article::$mPage
protected

The WikiPage object of this instance.

Definition at line 60 of file Article.php.

Referenced by getPage().

◆ $mParserOutput

ParserOutput null false Article::$mParserOutput = null

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

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

Deprecated:
since 1.32

Definition at line 85 of file Article.php.

◆ $mRedirectedFrom

Title null Article::$mRedirectedFrom = null

Title from which we were redirected here, if any.

Definition at line 69 of file Article.php.

Referenced by getRedirectedFrom().

◆ $mRedirectUrl

string bool Article::$mRedirectUrl = false

URL to redirect to or false if none.

Definition at line 72 of file Article.php.

◆ $viewIsRenderAction

bool Article::$viewIsRenderAction = false
protected

Whether render() was called.

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

Definition at line 92 of file Article.php.


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