MediaWiki master
MediaWiki\RevisionList\RevisionList Class Reference

Inherits MediaWiki\RevisionList\RevisionListBase.

Collaboration diagram for MediaWiki\RevisionList\RevisionList:

Public Member Functions

 doQuery ( $db)
 Do the DB query to iterate through the objects.
Parameters
IReadableDatabase$dbDB object to use for the query
Returns
IResultWrapper

 
 getType ()
 Get the internal type name of this list.Equal to the table name. Override this function.

Returns
string|null

 
 newItem ( $row)
 Create an item object from a DB result row.
Parameters
stdClass$row
Returns
RevisionItemBase

 
- Public Member Functions inherited from MediaWiki\RevisionList\RevisionListBase
 __construct (IContextSource $context, PageIdentity $page)
 Construct a revision list for a given page identity.
 
 current ()
 Get the current list item, or false if we are at the end.
 
 filterByIds (array $ids)
 Select items only where the ID is any of the specified values.
 
 getPage ()
 
 getPageName ()
 
 key ()
 
 length ()
 Get the number of items in the list.
 
 next ()
 Move the iteration pointer to the next list item, and return it.
 
 reset ()
 Start iteration.
 
 rewind ()
 
 valid ()
 
- Public Member Functions inherited from MediaWiki\Context\ContextSource
 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage().
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID.
 
 getActionName ()
 Get the action name for the current web request.
 
 getAuthority ()
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object.
 
 getCsrfTokenSet ()
 Get a repository to obtain and match CSRF tokens.
 
 getLanguage ()
 
 getLanguageCode ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object.
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage()
 
 setContext (IContextSource $context)
 

Additional Inherited Members

- Protected Member Functions inherited from MediaWiki\RevisionList\RevisionListBase
 initCurrent ()
 Initialise the current iteration pointer.
 
- Protected Attributes inherited from MediaWiki\RevisionList\RevisionListBase
RevisionItemBase false $current
 
int[] null $ids
 
PageIdentity $page
 
IResultWrapper false $res
 

Detailed Description

Definition at line 28 of file RevisionList.php.

Member Function Documentation

◆ doQuery()

MediaWiki\RevisionList\RevisionList::doQuery ( $db)

Do the DB query to iterate through the objects.

Parameters
IReadableDatabase$dbDB object to use for the query
Returns
IResultWrapper

Reimplemented from MediaWiki\RevisionList\RevisionListBase.

Definition at line 35 of file RevisionList.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ getType()

MediaWiki\RevisionList\RevisionList::getType ( )

Get the internal type name of this list.Equal to the table name. Override this function.

Returns
string|null

Reimplemented from MediaWiki\RevisionList\RevisionListBase.

Definition at line 30 of file RevisionList.php.

◆ newItem()

MediaWiki\RevisionList\RevisionList::newItem ( $row)

Create an item object from a DB result row.

Parameters
stdClass$row
Returns
RevisionItemBase

Reimplemented from MediaWiki\RevisionList\RevisionListBase.

Definition at line 49 of file RevisionList.php.


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