MediaWiki REL1_35
Public Member Functions | Public Attributes | Private Attributes | List of all members
MediaWiki\Storage\EditResult Class Reference

Object for storing information about the effects of an edit. More...

Public Member Functions

 __construct (bool $isNew, $originalRevisionId, ?int $revertMethod, ?int $oldestReverted, ?int $newestReverted, bool $isExactRevert, bool $isNullEdit, array $revertTags)
 EditResult constructor.
 
 getNewestRevertedRevisionId ()
 Returns the ID of the most recent revision that was reverted by this edit.
 
 getOldestRevertedRevisionId ()
 Returns the ID of the oldest revision that was reverted by this edit.
 
 getOriginalRevisionId ()
 Returns the ID of an earlier revision that is being repeated or restored.
 
 getRevertMethod ()
 Returns the revert method that was used to perform the edit, if any changes were reverted.
 
 getRevertTags ()
 Returns an array of revert-related tags that were applied automatically to this edit.
 
 getUndidRevId ()
 If the edit was an undo, returns the oldest revision that was undone.
 
 isExactRevert ()
 Whether the edit was an exact revert, i.e.
 
 isNew ()
 Whether the edit created a new page.
 
 isNullEdit ()
 An edit is a null edit if the original revision is equal to the parent revision, i.e.
 
 isRevert ()
 Whether the edit was a revert, not necessarily exact.
 

Public Attributes

const REVERT_MANUAL = 3
 
const REVERT_ROLLBACK = 2
 
const REVERT_UNDO = 1
 

Private Attributes

bool $isExactRevert
 
bool $isNew
 
bool $isNullEdit
 
int null $newestRevertedRevId
 
int null $oldestRevertedRevId
 
bool int $originalRevisionId
 
int null $revertMethod
 
string[] $revertTags
 

Detailed Description

Object for storing information about the effects of an edit.

This object should be constructed by an EditResultBuilder with relevant information filled in during the process of saving the revision by the PageUpdater. You can use it to extract information about whether the edit was a revert and which edits were reverted.

Since
1.35

Definition at line 36 of file EditResult.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Storage\EditResult::__construct ( bool  $isNew,
  $originalRevisionId,
?int  $revertMethod,
?int  $oldestReverted,
?int  $newestReverted,
bool  $isExactRevert,
bool  $isNullEdit,
array  $revertTags 
)

EditResult constructor.

Parameters
bool$isNew
bool | int$originalRevisionId
int | null$revertMethod
int | null$oldestReverted
int | null$newestReverted
bool$isExactRevert
bool$isNullEdit
string[]$revertTags

Definition at line 81 of file EditResult.php.

References MediaWiki\Storage\EditResult\$isExactRevert, MediaWiki\Storage\EditResult\$isNew, MediaWiki\Storage\EditResult\$isNullEdit, MediaWiki\Storage\EditResult\$originalRevisionId, MediaWiki\Storage\EditResult\$revertMethod, MediaWiki\Storage\EditResult\$revertTags, MediaWiki\Storage\EditResult\isExactRevert(), MediaWiki\Storage\EditResult\isNew(), and MediaWiki\Storage\EditResult\isNullEdit().

Member Function Documentation

◆ getNewestRevertedRevisionId()

MediaWiki\Storage\EditResult::getNewestRevertedRevisionId ( )

Returns the ID of the most recent revision that was reverted by this edit.

The same as getOldestRevertedRevisionId if only a single revision was reverted. Returns null if the edit was not a revert.

See also
EditResult::isRevert() for information on how a revert is defined
Returns
int|null

Definition at line 110 of file EditResult.php.

◆ getOldestRevertedRevisionId()

MediaWiki\Storage\EditResult::getOldestRevertedRevisionId ( )

Returns the ID of the oldest revision that was reverted by this edit.

The same as getOldestRevertedRevisionId if only a single revision was reverted. Returns null if the edit was not a revert.

See also
EditResult::isRevert() for information on how a revert is defined
Returns
int|null

Definition at line 123 of file EditResult.php.

◆ getOriginalRevisionId()

MediaWiki\Storage\EditResult::getOriginalRevisionId ( )

Returns the ID of an earlier revision that is being repeated or restored.

The original revision's content should match the new revision exactly.

Returns
bool|int The original revision id, or false if no earlier revision is known to be repeated or restored. The old PageUpdater::getOriginalRevisionId() returned false in such cases. This value would be then passed on to extensions through hooks, so it may be wise to keep compatibility with the old behavior.

Definition at line 151 of file EditResult.php.

◆ getRevertMethod()

MediaWiki\Storage\EditResult::getRevertMethod ( )

Returns the revert method that was used to perform the edit, if any changes were reverted.

Returns null if the edit was not a revert.

Possible values: REVERT_UNDO, REVERT_ROLLBACK, REVERT_MANUAL

See also
EditResult::isRevert()
Returns
int|null

Definition at line 194 of file EditResult.php.

◆ getRevertTags()

MediaWiki\Storage\EditResult::getRevertTags ( )

Returns an array of revert-related tags that were applied automatically to this edit.

Returns
string[]

Definition at line 223 of file EditResult.php.

◆ getUndidRevId()

MediaWiki\Storage\EditResult::getUndidRevId ( )

If the edit was an undo, returns the oldest revision that was undone.

Method kept for compatibility reasons.

Returns
int

Definition at line 133 of file EditResult.php.

◆ isExactRevert()

MediaWiki\Storage\EditResult::isExactRevert ( )

Whether the edit was an exact revert, i.e.

the contents of the revert revision and restored revision match

Returns
bool

Definition at line 204 of file EditResult.php.

Referenced by MediaWiki\Storage\EditResult\__construct().

◆ isNew()

MediaWiki\Storage\EditResult::isNew ( )

Whether the edit created a new page.

Returns
bool

Definition at line 160 of file EditResult.php.

Referenced by MediaWiki\Storage\EditResult\__construct().

◆ isNullEdit()

MediaWiki\Storage\EditResult::isNullEdit ( )

An edit is a null edit if the original revision is equal to the parent revision, i.e.

no changes were made.

Returns
bool

Definition at line 214 of file EditResult.php.

Referenced by MediaWiki\Storage\EditResult\__construct().

◆ isRevert()

MediaWiki\Storage\EditResult::isRevert ( )

Whether the edit was a revert, not necessarily exact.

An edit is considered a revert if it either:

  • Restores the page to an exact previous state (rollbacks, manual reverts and some undos). E.g. for edits A B C D, edits C and D are reverted.
  • Undoes some edits made previously, but automatic conflict resolution is done and possibly additional changes are made by the reverting user (undo). E.g. for edits A B C D, edits B and C are reverted.

To check whether the edit was an exact revert, please use the isExactRevert() method. The getRevertMethod() will provide additional information about which kind of revert was made.

Returns
bool

Definition at line 180 of file EditResult.php.

Member Data Documentation

◆ $isExactRevert

bool MediaWiki\Storage\EditResult::$isExactRevert
private

Definition at line 59 of file EditResult.php.

Referenced by MediaWiki\Storage\EditResult\__construct().

◆ $isNew

bool MediaWiki\Storage\EditResult::$isNew
private

Definition at line 44 of file EditResult.php.

Referenced by MediaWiki\Storage\EditResult\__construct().

◆ $isNullEdit

bool MediaWiki\Storage\EditResult::$isNullEdit
private

Definition at line 62 of file EditResult.php.

Referenced by MediaWiki\Storage\EditResult\__construct().

◆ $newestRevertedRevId

int null MediaWiki\Storage\EditResult::$newestRevertedRevId
private

Definition at line 53 of file EditResult.php.

◆ $oldestRevertedRevId

int null MediaWiki\Storage\EditResult::$oldestRevertedRevId
private

Definition at line 56 of file EditResult.php.

◆ $originalRevisionId

bool int MediaWiki\Storage\EditResult::$originalRevisionId
private

Definition at line 47 of file EditResult.php.

Referenced by MediaWiki\Storage\EditResult\__construct().

◆ $revertMethod

int null MediaWiki\Storage\EditResult::$revertMethod
private

Definition at line 50 of file EditResult.php.

Referenced by MediaWiki\Storage\EditResult\__construct().

◆ $revertTags

string [] MediaWiki\Storage\EditResult::$revertTags
private

Definition at line 65 of file EditResult.php.

Referenced by MediaWiki\Storage\EditResult\__construct().

◆ REVERT_MANUAL

const MediaWiki\Storage\EditResult::REVERT_MANUAL = 3

Definition at line 41 of file EditResult.php.

◆ REVERT_ROLLBACK

const MediaWiki\Storage\EditResult::REVERT_ROLLBACK = 2

Definition at line 40 of file EditResult.php.

◆ REVERT_UNDO

const MediaWiki\Storage\EditResult::REVERT_UNDO = 1

Definition at line 39 of file EditResult.php.

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