EditResultBuilder.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Storage;
 
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Revision\RevisionStore;
 
class EditResultBuilder {
 
    private $revisionRecord = null;
 
    private $isNew = false;
 
    private $originalRevisionId = false;
 
    private $originalRevision = null;
 
    private $revertMethod = null;
 
    private $newestRevertedRevId = null;
 
    private $oldestRevertedRevId = null;
 
    private $revisionStore;
 
    private $softwareTags;
 
    public function __construct( RevisionStore $revisionStore, array $softwareTags ) {
        $this->revisionStore = $revisionStore;
        $this->softwareTags = $softwareTags;
    }
 
    public function buildEditResult() : EditResult {
        if ( $this->revisionRecord === null ) {
            throw new PageUpdateException(
                'Revision was not set prior to building an EditResult'
            );
        }
 
        return new EditResult(
            $this->isNew,
            $this->originalRevisionId,
            $this->revertMethod,
            $this->oldestRevertedRevId,
            $this->newestRevertedRevId,
            $this->isExactRevert(),
            $this->isNullEdit(),
            $this->getRevertTags()
        );
    }
 
    public function setRevisionRecord( RevisionRecord $revisionRecord ) {
        $this->revisionRecord = $revisionRecord;
    }
 
    public function setIsNew( bool $isNew ) {
        $this->isNew = $isNew;
    }
 
    public function markAsRevert(
        int $revertMethod,
        int $oldestRevertedRevId,
        int $newestRevertedRevId = 0
    ) {
        if ( $oldestRevertedRevId === 0 ) {
            return;
        }
        if ( $newestRevertedRevId === 0 ) {
            $newestRevertedRevId = $oldestRevertedRevId;
        }
 
        $this->revertMethod = $revertMethod;
        $this->oldestRevertedRevId = $oldestRevertedRevId;
        $this->newestRevertedRevId = $newestRevertedRevId;
    }
 
    public function setOriginalRevisionId( $originalRevId ) {
        $this->originalRevisionId = $originalRevId;
    }
 
    private function getOriginalRevision(
        int $flags = RevisionStore::READ_NORMAL
    ) : ?RevisionRecord {
        if ( $this->originalRevision ) {
            return $this->originalRevision;
        }
        if ( $this->originalRevisionId === false ) {
            return null;
        }
 
        $this->originalRevision = $this->revisionStore->getRevisionById(
            $this->originalRevisionId,
            $flags
        );
        return $this->originalRevision;
    }
 
    private function isExactRevert() : bool {
        if ( $this->isNew || $this->oldestRevertedRevId === null ) {
            return false;
        }
 
        if ( $this->getOriginalRevision() === null ) {
            // we can't find the original revision for some reason, better return false
            return false;
        }
 
        return $this->revisionRecord->hasSameContent( $this->getOriginalRevision() );
    }
 
    private function isNullEdit() : bool {
        if ( $this->isNew ) {
            return false;
        }
 
        return $this->getOriginalRevision() &&
            $this->originalRevisionId === $this->revisionRecord->getParentId();
    }
 
    private function getRevertTags() : array {
        if ( $this->revertMethod === EditResult::REVERT_UNDO &&
            in_array( 'mw-undo', $this->softwareTags )
        ) {
            return [ 'mw-undo' ];
        } elseif ( $this->revertMethod === EditResult::REVERT_ROLLBACK &&
            in_array( 'mw-rollback', $this->softwareTags )
        ) {
            return [ 'mw-rollback' ];
        }
 
        return [];
    }
}