MediaWiki
master
|
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. More... | |
getNewestRevertedRevisionId () | |
Returns the ID of the most recent revision that was reverted by this edit. More... | |
getOldestRevertedRevisionId () | |
Returns the ID of the oldest revision that was reverted by this edit. More... | |
getOriginalRevisionId () | |
Returns the ID of an earlier revision that is being repeated or restored. More... | |
getRevertMethod () | |
Returns the revert method that was used to perform the edit, if any changes were reverted. More... | |
getRevertTags () | |
Returns an array of revert-related tags that were applied automatically to this edit. More... | |
getUndidRevId () | |
If the edit was an undo, returns the oldest revision that was undone. More... | |
isExactRevert () | |
Whether the edit was an exact revert, i.e. More... | |
isNew () | |
Whether the edit created a new page. More... | |
isNullEdit () | |
An edit is a null edit if the original revision is equal to the parent revision, i.e. More... | |
isRevert () | |
Whether the edit was a revert, not necessarily exact. More... | |
jsonSerialize () | |
Returns an array representing the EditResult object. More... | |
Static Public Member Functions | |
static | newFromArray (array $a) |
Recreate the EditResult object from its array representation. More... | |
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 |
const | SERIALIZATION_FORMAT_VERSION = '1' |
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.
Definition at line 38 of file EditResult.php.
MediaWiki\Storage\EditResult::__construct | ( | bool | $isNew, |
$originalRevisionId, | |||
?int | $revertMethod, | ||
?int | $oldestReverted, | ||
?int | $newestReverted, | ||
bool | $isExactRevert, | ||
bool | $isNullEdit, | ||
array | $revertTags | ||
) |
EditResult constructor.
bool | $isNew | |
bool | int | $originalRevisionId | |
int | null | $revertMethod | |
int | null | $oldestReverted | |
int | null | $newestReverted | |
bool | $isExactRevert | |
bool | $isNullEdit | |
string[] | $revertTags |
Definition at line 85 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().
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.
Definition at line 150 of file EditResult.php.
References MediaWiki\Storage\EditResult\$newestRevertedRevId.
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.
Definition at line 163 of file EditResult.php.
References MediaWiki\Storage\EditResult\$oldestRevertedRevId.
Referenced by MediaWiki\Storage\EditResult\getUndidRevId(), and MediaWiki\Storage\EditResult\isRevert().
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.
Definition at line 191 of file EditResult.php.
References MediaWiki\Storage\EditResult\$originalRevisionId.
Referenced by MediaWiki\Storage\PageUpdater\doModify(), and MediaWiki\Storage\PageUpdater\getAtomicSectionUpdate().
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
Definition at line 235 of file EditResult.php.
References MediaWiki\Storage\EditResult\$revertMethod.
Referenced by MediaWiki\Storage\EditResult\getUndidRevId().
MediaWiki\Storage\EditResult::getRevertTags | ( | ) |
Returns an array of revert-related tags that were applied automatically to this edit.
Definition at line 264 of file EditResult.php.
References MediaWiki\Storage\EditResult\$revertTags.
Referenced by MediaWiki\Storage\PageUpdater\computeEffectiveTags().
MediaWiki\Storage\EditResult::getUndidRevId | ( | ) |
If the edit was an undo, returns the oldest revision that was undone.
Method kept for compatibility reasons.
Definition at line 173 of file EditResult.php.
References MediaWiki\Storage\EditResult\getOldestRevertedRevisionId(), and MediaWiki\Storage\EditResult\getRevertMethod().
Referenced by MediaWiki\Storage\PageUpdater\getAtomicSectionUpdate().
MediaWiki\Storage\EditResult::isExactRevert | ( | ) |
Whether the edit was an exact revert, i.e.
the contents of the revert revision and restored revision match
Definition at line 245 of file EditResult.php.
References MediaWiki\Storage\EditResult\$isExactRevert.
Referenced by MediaWiki\Storage\EditResult\__construct().
MediaWiki\Storage\EditResult::isNew | ( | ) |
Whether the edit created a new page.
Definition at line 200 of file EditResult.php.
References MediaWiki\Storage\EditResult\$isNew.
Referenced by MediaWiki\Storage\EditResult\__construct(), and MediaWiki\Storage\EditResult\isRevert().
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.
Definition at line 255 of file EditResult.php.
References MediaWiki\Storage\EditResult\$isNullEdit.
Referenced by MediaWiki\Storage\EditResult\__construct().
MediaWiki\Storage\EditResult::isRevert | ( | ) |
Whether the edit was a revert, not necessarily exact.
An edit is considered a revert if it either:
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.
Definition at line 221 of file EditResult.php.
References MediaWiki\Storage\EditResult\getOldestRevertedRevisionId(), and MediaWiki\Storage\EditResult\isNew().
Referenced by MediaWiki\Storage\PageUpdater\getAtomicSectionUpdate().
MediaWiki\Storage\EditResult::jsonSerialize | ( | ) |
Returns an array representing the EditResult object.
-return array{isNew:bool,originalRevisionId:bool|int,revertMethod:int|null,newestRevertedRevId:int|null,oldestRevertedRevId:int|null,isExactRevert:bool,isNullEdit:bool,revertTags:string[],version:string}
Definition at line 280 of file EditResult.php.
References MediaWiki\Storage\EditResult\$isExactRevert, MediaWiki\Storage\EditResult\$isNew, MediaWiki\Storage\EditResult\$isNullEdit, MediaWiki\Storage\EditResult\$newestRevertedRevId, MediaWiki\Storage\EditResult\$oldestRevertedRevId, MediaWiki\Storage\EditResult\$originalRevisionId, MediaWiki\Storage\EditResult\$revertMethod, MediaWiki\Storage\EditResult\$revertTags, and MediaWiki\Storage\EditResult\SERIALIZATION_FORMAT_VERSION.
Referenced by RevertedTagUpdateJob\newSpec().
|
static |
Recreate the EditResult object from its array representation.
This must ONLY be used for deserializing EditResult objects serialized using EditResult::jsonSerialize(). The structure of the array may change without prior notice.
Any changes to the format are guaranteed to be backwards-compatible, so this method will work fine with old serialized EditResults.
For constructing EditResult objects from scratch use EditResultBuilder.
array | $a | -param array{isNew:bool,originalRevisionId:bool|int,revertMethod:int|null,newestRevertedRevId:int|null,oldestRevertedRevId:int|null,isExactRevert:bool,isNullEdit:bool,revertTags:string[],version:string} $a |
Definition at line 128 of file EditResult.php.
Referenced by MediaWiki\Storage\EditResultCache\get().
|
private |
Definition at line 63 of file EditResult.php.
Referenced by MediaWiki\Storage\EditResult\__construct(), MediaWiki\Storage\EditResult\isExactRevert(), and MediaWiki\Storage\EditResult\jsonSerialize().
|
private |
Definition at line 48 of file EditResult.php.
Referenced by MediaWiki\Storage\EditResult\__construct(), MediaWiki\Storage\EditResult\isNew(), and MediaWiki\Storage\EditResult\jsonSerialize().
|
private |
Definition at line 66 of file EditResult.php.
Referenced by MediaWiki\Storage\EditResult\__construct(), MediaWiki\Storage\EditResult\isNullEdit(), and MediaWiki\Storage\EditResult\jsonSerialize().
|
private |
Definition at line 57 of file EditResult.php.
Referenced by MediaWiki\Storage\EditResult\getNewestRevertedRevisionId(), and MediaWiki\Storage\EditResult\jsonSerialize().
|
private |
Definition at line 60 of file EditResult.php.
Referenced by MediaWiki\Storage\EditResult\getOldestRevertedRevisionId(), and MediaWiki\Storage\EditResult\jsonSerialize().
|
private |
Definition at line 51 of file EditResult.php.
Referenced by MediaWiki\Storage\EditResult\__construct(), MediaWiki\Storage\EditResult\getOriginalRevisionId(), and MediaWiki\Storage\EditResult\jsonSerialize().
|
private |
Definition at line 54 of file EditResult.php.
Referenced by MediaWiki\Storage\EditResult\__construct(), MediaWiki\Storage\EditResult\getRevertMethod(), and MediaWiki\Storage\EditResult\jsonSerialize().
|
private |
Definition at line 69 of file EditResult.php.
Referenced by MediaWiki\Storage\EditResult\__construct(), MediaWiki\Storage\EditResult\getRevertTags(), and MediaWiki\Storage\EditResult\jsonSerialize().
const MediaWiki\Storage\EditResult::REVERT_MANUAL = 3 |
Definition at line 43 of file EditResult.php.
Referenced by MediaWiki\Storage\EditResultBuilder\detectManualRevert().
const MediaWiki\Storage\EditResult::REVERT_ROLLBACK = 2 |
Definition at line 42 of file EditResult.php.
const MediaWiki\Storage\EditResult::REVERT_UNDO = 1 |
Definition at line 41 of file EditResult.php.
|
private |
Definition at line 45 of file EditResult.php.
Referenced by MediaWiki\Storage\EditResult\jsonSerialize().