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, 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...
 
 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...
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 

Public Attributes

Title $title
 

Protected Member Functions

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

Protected Attributes

bool Revision $current
 
array $ids
 
ResultWrapper bool $res
 

Detailed Description

List for revision table items for a single page.

Definition at line 29 of file RevisionListBase.php.

Constructor & Destructor Documentation

◆ __construct()

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

Construct a revision list for a given title.

Parameters
IContextSource$context
Title$title

Definition at line 47 of file RevisionListBase.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.

Returns
Revision

Definition at line 103 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

Referenced by length(), 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
array$ids

Definition at line 56 of file RevisionListBase.php.

References $ids.

◆ getType()

RevisionListBase::getType ( )

Get the internal type name of this list.

Equal to the table name. Override this function.

Returns
null

Definition at line 65 of file RevisionListBase.php.

References null.

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

◆ initCurrent()

RevisionListBase::initCurrent ( )
protected

Initialise the current iteration pointer.

Definition at line 72 of file RevisionListBase.php.

References current(), and newItem().

Referenced by next(), and reset().

◆ key()

RevisionListBase::key ( )

Definition at line 117 of file RevisionListBase.php.

◆ length()

RevisionListBase::length ( )

Get the number of items in the list.

Returns
int

Definition at line 129 of file RevisionListBase.php.

References doQuery(), and newItem().

◆ newItem()

RevisionListBase::newItem (   $row)
abstract

Create an item object from a DB result row.

Parameters
object$row

Referenced by initCurrent(), and length().

◆ next()

RevisionListBase::next ( )

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

Returns
Revision

Definition at line 111 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
Revision First list item

Definition at line 85 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 95 of file RevisionListBase.php.

References reset().

◆ valid()

RevisionListBase::valid ( )

Definition at line 121 of file RevisionListBase.php.

Member Data Documentation

◆ $current

bool Revision RevisionListBase::$current
protected

Definition at line 40 of file RevisionListBase.php.

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

◆ $ids

◆ $res

ResultWrapper bool RevisionListBase::$res
protected

Definition at line 37 of file RevisionListBase.php.

◆ $title

Title RevisionListBase::$title

Definition at line 31 of file RevisionListBase.php.

Referenced by __construct().


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