MediaWiki  master
RevisionListBase Class Reference

List for revision table items for a single page. More...

Inheritance diagram for RevisionListBase:
Collaboration diagram for RevisionListBase:

Public Member Functions

 __construct (IContextSource $context, PageIdentity $page)
 Construct a revision list for a given title. More...
 
 current ()
 Get the current list item, or false if we are at the end. More...
 
 doQuery ( $db)
 Do the DB query to iterate through the objects. More...
 
 filterByIds (array $ids)
 Select items only where the ID is any of the specified values. More...
 
 getPage ()
 
 getPageName ()
 
 getType ()
 Get the internal type name of this list. More...
 
 key ()
 
 length ()
 Get the number of items in the list. More...
 
 newItem ( $row)
 Create an item object from a DB result row. More...
 
 next ()
 Move the iteration pointer to the next list item, and return it. More...
 
 reset ()
 Start iteration. More...
 
 rewind ()
 
 valid ()
 
- Public Member Functions inherited from ContextSource
 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage(). More...
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID. More...
 
 getAuthority ()
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getCsrfTokenSet ()
 Get a repository to obtain and match CSRF tokens. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 

Protected Member Functions

 initCurrent ()
 Initialise the current iteration pointer. More...
 

Protected Attributes

RevisionItemBase false $current
 
int[] null $ids
 
IResultWrapper false $res
 
Title $title
 

Detailed Description

List for revision table items for a single page.

Definition at line 30 of file RevisionListBase.php.

Constructor & Destructor Documentation

◆ __construct()

RevisionListBase::__construct ( IContextSource  $context,
PageIdentity  $page 
)

Construct a revision list for a given title.

Parameters
IContextSource$context
PageIdentity$page

Definition at line 50 of file RevisionListBase.php.

References $title, Title\castFromPageIdentity(), deprecatePublicPropertyFallback(), and ContextSource\setContext().

Member Function Documentation

◆ current()

RevisionListBase::current ( )

Get the current list item, or false if we are at the end.

Returns
RevisionItemBase

Definition at line 125 of file RevisionListBase.php.

References $current.

Referenced by initCurrent(), ChangeTagsLogList\updateChangeTagsOnAll(), and ChangeTagsRevisionList\updateChangeTagsOnAll().

◆ doQuery()

RevisionListBase::doQuery (   $db)
abstract

Do the DB query to iterate through the objects.

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

Reimplemented in RevisionList, RevDelRevisionList, RevDelLogList, RevDelFileList, RevDelArchiveList, RevDelArchivedFileList, ChangeTagsRevisionList, and ChangeTagsLogList.

Referenced by ChangeTagsList\reloadFromMaster(), RevDelList\reloadFromMaster(), reset(), and RevDelList\setVisibility().

◆ filterByIds()

RevisionListBase::filterByIds ( array  $ids)

Select items only where the ID is any of the specified values.

Parameters
int[]$ids

Definition at line 78 of file RevisionListBase.php.

References $ids.

◆ getPage()

RevisionListBase::getPage ( )
Returns
PageIdentity

Definition at line 62 of file RevisionListBase.php.

References $title.

Referenced by RevDelArchiveList\doQuery(), and RevDelArchiveItem\initRevisionRecord().

◆ getPageName()

RevisionListBase::getPageName ( )
Access: internal
for use by RevDelItems
Returns
string

Definition at line 70 of file RevisionListBase.php.

◆ getType()

RevisionListBase::getType ( )

Get the internal type name of this list.

Equal to the table name. Override this function.

Returns
string|null

Reimplemented in RevisionList, RevDelRevisionList, RevDelLogList, RevDelFileList, RevDelArchiveList, RevDelArchivedFileList, ChangeTagsRevisionList, and ChangeTagsLogList.

Definition at line 87 of file RevisionListBase.php.

Referenced by RevDelList\getLogParams(), and RevDelList\updateLog().

◆ initCurrent()

RevisionListBase::initCurrent ( )
protected

Initialise the current iteration pointer.

Definition at line 94 of file RevisionListBase.php.

References current(), and newItem().

Referenced by next(), and reset().

◆ key()

RevisionListBase::key ( )

Definition at line 140 of file RevisionListBase.php.

◆ length()

RevisionListBase::length ( )

Get the number of items in the list.

Returns
int

Definition at line 152 of file RevisionListBase.php.

◆ newItem()

RevisionListBase::newItem (   $row)
abstract

Create an item object from a DB result row.

Parameters
stdClass$row
Returns
RevisionItemBase

Reimplemented in RevisionList, RevDelRevisionList, RevDelLogList, RevDelFileList, RevDelArchiveList, RevDelArchivedFileList, ChangeTagsRevisionList, and ChangeTagsLogList.

Referenced by initCurrent().

◆ next()

RevisionListBase::next ( )

Move the iteration pointer to the next list item, and return it.

Returns
RevisionItemBase

Definition at line 134 of file RevisionListBase.php.

References $current, and initCurrent().

Referenced by ChangeTagsLogList\updateChangeTagsOnAll(), and ChangeTagsRevisionList\updateChangeTagsOnAll().

◆ reset()

RevisionListBase::reset ( )

Start iteration.

This must be called before current() or next().

Returns
RevisionItemBase First list item

Definition at line 107 of file RevisionListBase.php.

References $current, DB_REPLICA, doQuery(), initCurrent(), and wfGetDB().

Referenced by rewind(), ChangeTagsLogList\updateChangeTagsOnAll(), and ChangeTagsRevisionList\updateChangeTagsOnAll().

◆ rewind()

RevisionListBase::rewind ( )

Definition at line 117 of file RevisionListBase.php.

References reset().

◆ valid()

RevisionListBase::valid ( )

Definition at line 144 of file RevisionListBase.php.

Member Data Documentation

◆ $current

RevisionItemBase false RevisionListBase::$current
protected

Definition at line 43 of file RevisionListBase.php.

Referenced by current(), next(), and reset().

◆ $ids

◆ $res

IResultWrapper false RevisionListBase::$res
protected

Definition at line 40 of file RevisionListBase.php.

◆ $title

Title RevisionListBase::$title
protected

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