Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

EditResult: improve documentation

Browse source 
As the EditResult class changes a few things slightly and may be
a bit confusing for developers, I clarified it a bit in the
comments.

It would be probably useful to document this properly on mediawiki.org,
which I'll do once a few things with EditResult are sorted out.

Bug: T254074
Change-Id: Ic8d654ce2c10f079c5a3f417cb2dc0f6e5d7b5b2
This commit is contained in:
Ostrzyciel 2020-07-09 16:02:21 +02:00
parent acf5e4e5b6
commit 7d5fa77324
1 changed files with 22 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
includes/Storage/EditResult.php
View file

@ -103,6 +103,8 @@ class EditResult {
* The same as getOldestRevertedRevisionId if only a single revision was
* reverted. Returns null if the edit was not a revert.
*
* @see EditResult::isRevert() for information on how a revert is defined
*
* @return int|null
*/
public function getNewestRevertedRevisionId() : ?int {
@ -114,6 +116,8 @@ class EditResult {
* The same as getOldestRevertedRevisionId if only a single revision was
* reverted. Returns null if the edit was not a revert.
*
* @see EditResult::isRevert() for information on how a revert is defined
*
* @return int|null
*/
public function getOldestRevertedRevisionId() : ?int {
@ -136,6 +140,8 @@ class EditResult {
/**
* Returns the ID of an earlier revision that is being repeated or restored.
*
* The original revision's content should match the new revision exactly.
*
* @return 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
@ -156,7 +162,18 @@ class EditResult {
}
/**
* Whether the edit was a revert, not necessarily exact
* 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.
*
* @return bool
*/
@ -170,6 +187,8 @@ class EditResult {
*
* Possible values: REVERT_UNDO, REVERT_ROLLBACK, REVERT_MANUAL
*
* @see EditResult::isRevert()
*
* @return int|null
*/
public function getRevertMethod() : ?int {
@ -187,7 +206,8 @@ class EditResult {
}
/**
* An edit is a null edit if the original revision is equal to the parent revision.
* An edit is a null edit if the original revision is equal to the parent revision,
* i.e. no changes were made.
*
* @return bool
*/