MediaWiki  1.28.1
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 ()
 Get the Config object. More...
 
 getContext ()
 Get the base IContextSource 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...
 
 getStats ()
 Get the Stats object. More...
 
 getTiming ()
 Get the Timing 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

Title $title
 

Protected Member Functions

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

Protected Attributes

bool object $current
 
array $ids
 
ResultWrapper bool $res
 

Detailed Description

List for revision table items for a single page.

Definition at line 26 of file RevisionList.php.

Constructor & Destructor Documentation

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

Construct a revision list for a given title.

Parameters
IContextSource$context
Title$title

Definition at line 44 of file RevisionList.php.

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

Member Function Documentation

RevisionListBase::current ( )

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

Returns
Revision

Definition at line 100 of file RevisionList.php.

References $current.

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

RevisionListBase::doQuery (   $db)
abstract

Do the DB query to iterate through the objects.

Parameters
IDatabase$dbDB object to use for the query

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

RevisionListBase::filterByIds ( array  $ids)

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

Parameters
array$ids

Definition at line 53 of file RevisionList.php.

References $ids.

RevisionListBase::getType ( )

Get the internal type name of this list.

Equal to the table name. Override this function.

Returns
null

Definition at line 62 of file RevisionList.php.

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

RevisionListBase::initCurrent ( )
protected

Initialise the current iteration pointer.

Definition at line 69 of file RevisionList.php.

References current(), and newItem().

Referenced by next(), and reset().

RevisionListBase::key ( )

Definition at line 114 of file RevisionList.php.

RevisionListBase::length ( )

Get the number of items in the list.

Returns
int

Definition at line 126 of file RevisionList.php.

RevisionListBase::newItem (   $row)
abstract

Create an item object from a DB result row.

Parameters
object$row

Referenced by initCurrent().

RevisionListBase::next ( )

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

Returns
Revision

Definition at line 108 of file RevisionList.php.

References $current, and initCurrent().

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

RevisionListBase::reset ( )

Start iteration.

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

Returns
Revision First list item

Definition at line 82 of file RevisionList.php.

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

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

RevisionListBase::rewind ( )

Definition at line 92 of file RevisionList.php.

References reset().

RevisionListBase::valid ( )

Definition at line 118 of file RevisionList.php.

Member Data Documentation

bool object RevisionListBase::$current
protected

Definition at line 37 of file RevisionList.php.

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

ResultWrapper bool RevisionListBase::$res
protected

Definition at line 34 of file RevisionList.php.

Title RevisionListBase::$title

Definition at line 28 of file RevisionList.php.

Referenced by __construct().


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