MediaWiki  1.23.12
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, Title $title)
 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...
 
 getType ()
 Get the internal type name of this list. More...
 
 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...
 
- 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...
 
 getConfig ()
 Get the Config object. More...
 
 getContext ()
 Get the RequestContext object. More...
 
 getLang ()
 Get the Language object. More...
 
 getLanguage ()
 Get the Language object. More...
 
 getOutput ()
 Get the OutputPage object. More...
 
 getRequest ()
 Get the WebRequest object. More...
 
 getSkin ()
 Get the Skin object. More...
 
 getTitle ()
 Get the Title object. More...
 
 getUser ()
 Get the User object. More...
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ()
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 Set the IContextSource object. More...
 

Public Attributes

 $current
 
 $ids
 
 $res
 
Title $title
 

Protected Member Functions

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

Detailed Description

List for revision table items for a single page.

Definition at line 26 of file RevisionList.php.

Constructor & Destructor Documentation

◆ __construct()

RevisionListBase::__construct ( IContextSource  $context,
Title  $title 
)

Construct a revision list for a given title.

Parameters
$contextIContextSource
$titleTitle

Definition at line 38 of file RevisionList.php.

References $title, ContextSource\setContext(), and title.

Member Function Documentation

◆ current()

RevisionListBase::current ( )

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

Definition at line 89 of file RevisionList.php.

References $current.

Referenced by initCurrent(), and RevDel_List\setVisibility().

◆ doQuery()

RevisionListBase::doQuery (   $db)
abstract

Do the DB query to iterate through the objects.

Parameters
$dbDatabaseBase object to use for the query

Reimplemented in RevDel_LogList, RevDel_ArchivedFileList, RevDel_FileList, RevDel_ArchiveList, RevisionList, and RevDel_RevisionList.

Referenced by RevDel_List\reloadFromMaster(), reset(), and RevDel_List\setVisibility().

◆ filterByIds()

RevisionListBase::filterByIds ( array  $ids)

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

Parameters
$idsArray

Definition at line 47 of file RevisionList.php.

References $ids.

◆ getType()

RevisionListBase::getType ( )

Get the internal type name of this list.

Equal to the table name. Override this function.

Returns
null

Reimplemented in RevDel_LogList, RevDel_ArchivedFileList, RevDel_FileList, RevDel_ArchiveList, RevisionList, and RevDel_RevisionList.

Definition at line 56 of file RevisionList.php.

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

◆ initCurrent()

RevisionListBase::initCurrent ( )
protected

Initialise the current iteration pointer.

Definition at line 63 of file RevisionList.php.

References current(), and newItem().

Referenced by next(), and reset().

◆ length()

RevisionListBase::length ( )

Get the number of items in the list.

Returns
int

Definition at line 106 of file RevisionList.php.

◆ newItem()

RevisionListBase::newItem (   $row)
abstract

Create an item object from a DB result row.

Parameters
$rowstdclass

Reimplemented in RevDel_LogList, RevDel_ArchivedFileList, RevDel_FileList, RevDel_ArchiveList, RevisionList, and RevDel_RevisionList.

Referenced by initCurrent().

◆ next()

RevisionListBase::next ( )

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

Definition at line 96 of file RevisionList.php.

References $current, and initCurrent().

Referenced by RevDel_List\setVisibility().

◆ reset()

RevisionListBase::reset ( )

Start iteration.

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

Returns
First list item

Definition at line 76 of file RevisionList.php.

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

Referenced by RevDel_List\setVisibility().

Member Data Documentation

◆ $current

RevisionListBase::$current

Definition at line 31 of file RevisionList.php.

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

◆ $ids

◆ $res

RevisionListBase::$res

Definition at line 31 of file RevisionList.php.

◆ $title

Title RevisionListBase::$title

Definition at line 29 of file RevisionList.php.

Referenced by RevDel_List\__construct(), and __construct().


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