MediaWiki master
ChangeTagsRevisionList Class Reference

Stores a list of taggable revisions. More...

Inherits ChangeTagsList.

Collaboration diagram for ChangeTagsRevisionList:

Public Member Functions

 doQuery ( $db)
 
 getType ()
 Get the internal type name of this list.
 
 newItem ( $row)
 Create an item object from a DB result row.
 
 updateChangeTagsOnAll (array $tagsToAdd, array $tagsToRemove, ?string $params, string $reason, Authority $performer)
 Add/remove change tags from all the revisions in the list.
 
- Public Member Functions inherited from ChangeTagsList
 __construct (IContextSource $context, PageIdentity $page, array $ids)
 
 reloadFromPrimary ()
 Reload the list data from the primary DB.
 
- Public Member Functions inherited from 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

- Static Public Member Functions inherited from ChangeTagsList
static factory ( $typeName, IContextSource $context, PageIdentity $page, array $ids)
 Creates a ChangeTags*List of the requested type.
 
- Protected Member Functions inherited from RevisionListBase
 initCurrent ()
 Initialise the current iteration pointer.
 
- Protected Attributes inherited from RevisionListBase
RevisionItemBase false $current
 
int[] null $ids
 
PageIdentity $page
 
IResultWrapper false $res
 

Detailed Description

Stores a list of taggable revisions.

Since
1.25

Definition at line 32 of file ChangeTagsRevisionList.php.

Member Function Documentation

◆ doQuery()

ChangeTagsRevisionList::doQuery ( $db)
Parameters
\\Wikimedia\\Rdbms\\IReadableDatabase$db
Returns
IResultWrapper

Reimplemented from RevisionListBase.

Definition at line 41 of file ChangeTagsRevisionList.php.

References RevisionListBase\$ids.

◆ getType()

ChangeTagsRevisionList::getType ( )

Get the internal type name of this list.

Equal to the table name. Override this function.

Returns
string|null

Reimplemented from RevisionListBase.

Definition at line 33 of file ChangeTagsRevisionList.php.

◆ newItem()

ChangeTagsRevisionList::newItem ( $row)

Create an item object from a DB result row.

Parameters
stdClass$row
Returns
RevisionItemBase

Reimplemented from RevisionListBase.

Definition at line 53 of file ChangeTagsRevisionList.php.

◆ updateChangeTagsOnAll()

ChangeTagsRevisionList::updateChangeTagsOnAll ( array $tagsToAdd,
array $tagsToRemove,
?string $params,
string $reason,
Authority $performer )

Add/remove change tags from all the revisions in the list.

Parameters
string[]$tagsToAdd
string[]$tagsToRemove
string | null$params
string$reason
Authority$performer
Returns
Status

Reimplemented from ChangeTagsList.

Definition at line 67 of file ChangeTagsRevisionList.php.

References $params, RevisionListBase\current(), RevisionListBase\next(), RevisionListBase\reset(), and ChangeTags\updateTagsWithChecks().


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