MediaWiki  1.30.0
ChangeTagsList Class Reference

Generic list for change tagging. More...

Inheritance diagram for ChangeTagsList:
Collaboration diagram for ChangeTagsList:

Public Member Functions

 __construct (IContextSource $context, Title $title, array $ids)
 
 reloadFromMaster ()
 Reload the list data from the master DB. More...
 
 updateChangeTagsOnAll ( $tagsToAdd, $tagsToRemove, $params, $reason, $user)
 Add/remove change tags from all the items in the list. More...
 
- Public Member Functions inherited from RevisionListBase
 __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 ( $key)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 Set the IContextSource object. More...
 

Static Public Member Functions

static factory ( $typeName, IContextSource $context, Title $title, array $ids)
 Creates a ChangeTags*List of the requested type. More...
 

Additional Inherited Members

- Public Attributes inherited from RevisionListBase
Title $title
 
- Protected Member Functions inherited from RevisionListBase
 initCurrent ()
 Initialise the current iteration pointer. More...
 
- Protected Attributes inherited from RevisionListBase
bool Revision $current
 
array $ids
 
ResultWrapper bool $res
 

Detailed Description

Generic list for change tagging.

Definition at line 25 of file ChangeTagsList.php.

Constructor & Destructor Documentation

◆ __construct()

ChangeTagsList::__construct ( IContextSource  $context,
Title  $title,
array  $ids 
)

Member Function Documentation

◆ factory()

static ChangeTagsList::factory (   $typeName,
IContextSource  $context,
Title  $title,
array  $ids 
)
static

Creates a ChangeTags*List of the requested type.

Parameters
string$typeName'revision' or 'logentry'
IContextSource$context
Title$title
array$ids
Returns
ChangeTagsList An instance of the requested subclass
Exceptions
ExceptionIf you give an unknown $typeName

Definition at line 41 of file ChangeTagsList.php.

References ContextSource\$context, RevisionListBase\$ids, and RevisionListBase\$title.

Referenced by SpecialEditTags\getList().

◆ reloadFromMaster()

ChangeTagsList::reloadFromMaster ( )

Reload the list data from the master DB.

Definition at line 61 of file ChangeTagsList.php.

References DB_MASTER, RevisionListBase\doQuery(), and wfGetDB().

◆ updateChangeTagsOnAll()

ChangeTagsList::updateChangeTagsOnAll (   $tagsToAdd,
  $tagsToRemove,
  $params,
  $reason,
  $user 
)
abstract

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

Parameters
array$tagsToAdd
array$tagsToRemove
array$params
string$reason
User$user
Returns
Status

Reimplemented in ChangeTagsRevisionList, and ChangeTagsLogList.


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