EditResult.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Storage;
 
use JsonSerializable;
 
class EditResult implements JsonSerializable {
 
    // revert methods
    public const REVERT_UNDO = 1;
    public const REVERT_ROLLBACK = 2;
    public const REVERT_MANUAL = 3;
 
    private const SERIALIZATION_FORMAT_VERSION = '1';
 
    private $isNew;
 
    private $originalRevisionId;
 
    private $revertMethod;
 
    private $newestRevertedRevId;
 
    private $oldestRevertedRevId;
 
    private $isExactRevert;
 
    private $isNullEdit;
 
    private $revertTags;
 
    public function __construct(
        bool $isNew,
        $originalRevisionId,
        ?int $revertMethod,
        ?int $oldestReverted,
        ?int $newestReverted,
        bool $isExactRevert,
        bool $isNullEdit,
        array $revertTags
    ) {
        $this->isNew = $isNew;
        $this->originalRevisionId = $originalRevisionId;
        $this->revertMethod = $revertMethod;
        $this->oldestRevertedRevId = $oldestReverted;
        $this->newestRevertedRevId = $newestReverted;
        $this->isExactRevert = $isExactRevert;
        $this->isNullEdit = $isNullEdit;
        $this->revertTags = $revertTags;
    }
 
    public static function newFromArray( array $a ) {
        return new self(
            $a['isNew'],
            $a['originalRevisionId'],
            $a['revertMethod'],
            $a['oldestRevertedRevId'],
            $a['newestRevertedRevId'],
            $a['isExactRevert'],
            $a['isNullEdit'],
            $a['revertTags']
        );
    }
 
    public function getNewestRevertedRevisionId(): ?int {
        return $this->newestRevertedRevId;
    }
 
    public function getOldestRevertedRevisionId(): ?int {
        return $this->oldestRevertedRevId;
    }
 
    public function getUndidRevId(): int {
        if ( $this->getRevertMethod() !== self::REVERT_UNDO ) {
            return 0;
        }
        return $this->getOldestRevertedRevisionId() ?? 0;
    }
 
    public function getOriginalRevisionId() {
        return $this->originalRevisionId;
    }
 
    public function isNew(): bool {
        return $this->isNew;
    }
 
    public function isRevert(): bool {
        return !$this->isNew() && $this->getOldestRevertedRevisionId();
    }
 
    public function getRevertMethod(): ?int {
        return $this->revertMethod;
    }
 
    public function isExactRevert(): bool {
        return $this->isExactRevert;
    }
 
    public function isNullEdit(): bool {
        return $this->isNullEdit;
    }
 
    public function getRevertTags(): array {
        return $this->revertTags;
    }
 
    #[\ReturnTypeWillChange]
    public function jsonSerialize() {
        return [
            'isNew' => $this->isNew,
            'originalRevisionId' => $this->originalRevisionId,
            'revertMethod' => $this->revertMethod,
            'newestRevertedRevId' => $this->newestRevertedRevId,
            'oldestRevertedRevId' => $this->oldestRevertedRevId,
            'isExactRevert' => $this->isExactRevert,
            'isNullEdit' => $this->isNullEdit,
            'revertTags' => $this->revertTags,
            'version' => self::SERIALIZATION_FORMAT_VERSION
        ];
    }
}