MediaWiki master
MediaWiki\ChangeTags\ChangeTagsList Class Reference

Inherits MediaWiki\RevisionList\RevisionListBase.

Inherited by MediaWiki\ChangeTags\ChangeTagsLogList, and MediaWiki\ChangeTags\ChangeTagsRevisionList.

Collaboration diagram for MediaWiki\ChangeTags\ChangeTagsList:

Public Member Functions

 __construct (IContextSource $context, PageIdentity $page, array $ids)
 
 reloadFromPrimary ()
 Reload the list data from the primary DB.
 
 updateChangeTagsOnAll (array $tagsToAdd, array $tagsToRemove, ?string $params, string $reason, Authority $performer)
 Add/remove change tags from all the items in the list.
 
- Public Member Functions inherited from MediaWiki\RevisionList\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.
 
 doQuery ( $db)
 Do the DB query to iterate through the objects.
 
 filterByIds (array $ids)
 Select items only where the ID is any of the specified values.
 
 getPage ()
 
 getPageName ()
 
 getType ()
 Get the internal type name of this list.
 
 key ()
 
 length ()
 Get the number of items in the list.
 
 newItem ( $row)
 Create an item object from a DB result row.
 
 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)
 

Static Public Member Functions

static factory ( $typeName, IContextSource $context, PageIdentity $page, array $ids)
 Create a ChangeTagsList instance of the given type.
 

Additional Inherited Members

- Protected Member Functions inherited from MediaWiki\RevisionList\RevisionListBase
 initCurrent ()
 Initialise the current iteration pointer.
 
- Protected Attributes inherited from MediaWiki\RevisionList\RevisionListBase
RevisionItemBase false $current
 
int[] null $ids
 
PageIdentity $page
 
IResultWrapper false $res
 

Detailed Description

Definition at line 40 of file ChangeTagsList.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\ChangeTags\ChangeTagsList::__construct ( IContextSource $context,
PageIdentity $page,
array $ids )

Member Function Documentation

◆ factory()

static MediaWiki\ChangeTags\ChangeTagsList::factory ( $typeName,
IContextSource $context,
PageIdentity $page,
array $ids )
static

Create a ChangeTagsList instance of the given type.

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

Definition at line 56 of file ChangeTagsList.php.

References MediaWiki\RevisionList\RevisionListBase\$ids, and MediaWiki\RevisionList\RevisionListBase\$page.

Referenced by MediaWiki\Specials\SpecialEditTags\getList().

◆ reloadFromPrimary()

MediaWiki\ChangeTags\ChangeTagsList::reloadFromPrimary ( )

Reload the list data from the primary DB.

Definition at line 76 of file ChangeTagsList.php.

References MediaWiki\RevisionList\RevisionListBase\doQuery(), and MediaWiki\MediaWikiServices\getInstance().

◆ updateChangeTagsOnAll()

MediaWiki\ChangeTags\ChangeTagsList::updateChangeTagsOnAll ( array $tagsToAdd,
array $tagsToRemove,
?string $params,
string $reason,
Authority $performer )
abstract

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

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

Reimplemented in MediaWiki\ChangeTags\ChangeTagsLogList, and MediaWiki\ChangeTags\ChangeTagsRevisionList.


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