MediaWiki\Storage\RevertedTagUpdate Class Reference

Adds the mw-reverted tag to reverted edits after a revert is made. More...

Inheritance diagram for MediaWiki\Storage\RevertedTagUpdate:

Collaboration diagram for MediaWiki\Storage\RevertedTagUpdate:

Public Member Functions
	__construct (RevisionStore $revisionStore, LoggerInterface $logger, array $softwareTags, ILoadBalancer $loadBalancer, ServiceOptions $serviceOptions, int $revertId, EditResult $editResult)
	doUpdate ()
	Marks reverted edits with mw-reverted tag. More...

Public Attributes
const	CONSTRUCTOR_OPTIONS = [ MainConfigNames::RevertedTagMaxDepth ]

Protected Member Functions
	getChangeTags (int $revisionId)
	Protected function calling static ChangeTags class to allow for unit testing of this deferrable update. More...
	markAsReverted (int $revisionId, array $extraParams)
	Protected function calling static ChangeTags class to allow for unit testing of this deferrable update. More...

Detailed Description

Adds the mw-reverted tag to reverted edits after a revert is made.

This class is used by RevertedTagUpdateJob to perform the actual update.

Since

1.36

Author

Ostrzyciel

Definition at line 41 of file RevertedTagUpdate.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Storage\RevertedTagUpdate::__construct	(	RevisionStore	$revisionStore,
		LoggerInterface	$logger,
		array	$softwareTags,
		ILoadBalancer	$loadBalancer,
		ServiceOptions	$serviceOptions,
		int	$revertId,
		EditResult	$editResult
	)

Parameters

RevisionStore	$revisionStore
LoggerInterface	$logger
string[]	$softwareTags	Array of currently enabled software change tags. Can be obtained from ChangeTags::getSoftwareTags()
ILoadBalancer	$loadBalancer
ServiceOptions	$serviceOptions
int	$revertId	ID of the revert
EditResult	$editResult	EditResult object of this revert

Definition at line 88 of file RevertedTagUpdate.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions().

Member Function Documentation

doUpdate()

MediaWiki\Storage\RevertedTagUpdate::doUpdate

(

)

Marks reverted edits with mw-reverted tag.

Implements DeferrableUpdate.

Definition at line 111 of file RevertedTagUpdate.php.

References MediaWiki\Revision\RevisionStore\INCLUDE_BOTH, MediaWiki\Storage\RevertedTagUpdate\markAsReverted(), and MediaWiki\MainConfigNames\RevertedTagMaxDepth.

getChangeTags()

MediaWiki\Storage\RevertedTagUpdate::getChangeTags ( int  $revisionId )

protected

Protected function calling static ChangeTags class to allow for unit testing of this deferrable update.

This class is not stable for extending, this is just to make the class testable.

ChangeTags should be passed by dependency injection when that becomes possible. See: T245964

Parameters

int

$revisionId

Returns

string[]

Definition at line 319 of file RevertedTagUpdate.php.

References DB_REPLICA, and ChangeTags\getTags().

markAsReverted()

MediaWiki\Storage\RevertedTagUpdate::markAsReverted ( int  $revisionId, array  $extraParams  )

protected

Protected function calling static ChangeTags class to allow for unit testing of this deferrable update.

This class is not stable for extending, this is just to make the class testable.

ChangeTags should be passed by dependency injection when that becomes possible. See: T245964

Parameters

int	$revisionId	ID of the revision to mark as reverted
array	$extraParams	Params to put in the ct_params field of table 'change_tag'

Definition at line 296 of file RevertedTagUpdate.php.

References ChangeTags\addTags(), FormatJson\encode(), and ChangeTags\TAG_REVERTED.

Referenced by MediaWiki\Storage\RevertedTagUpdate\doUpdate().

Member Data Documentation

CONSTRUCTOR_OPTIONS

const MediaWiki\Storage\RevertedTagUpdate::CONSTRUCTOR_OPTIONS = [ MainConfigNames::RevertedTagMaxDepth ]

Access: internal

Definition at line 46 of file RevertedTagUpdate.php.

---

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

• includes/Storage/RevertedTagUpdate.php