RevDelArchiveList.php

Go to the documentation of this file.

<?php
namespace MediaWiki\RevisionDelete;
 
use MediaWiki\Cache\HTMLCacheUpdater;
use MediaWiki\Context\IContextSource;
use MediaWiki\DomainEvent\DomainEventDispatcher;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\Logging\LogEntry;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Revision\RevisionStore;
use MediaWiki\Status\Status;
use Wikimedia\Rdbms\IResultWrapper;
use Wikimedia\Rdbms\LBFactory;
use Wikimedia\Rdbms\SelectQueryBuilder;
 
class RevDelArchiveList extends RevDelRevisionList {
 
    private $revisionStore;
 
    public function __construct(
        IContextSource $context,
        PageIdentity $page,
        array $ids,
        LBFactory $lbFactory,
        HookContainer $hookContainer,
        HTMLCacheUpdater $htmlCacheUpdater,
        RevisionStore $revisionStore,
        DomainEventDispatcher $eventDispatcher
    ) {
        parent::__construct(
            $context,
            $page,
            $ids,
            $lbFactory,
            $hookContainer,
            $htmlCacheUpdater,
            $revisionStore,
            $eventDispatcher
        );
        $this->revisionStore = $revisionStore;
    }
 
    public function getType() {
        return 'archive';
    }
 
    public static function getRelationType() {
        return 'ar_timestamp';
    }
 
    public function doQuery( $db ) {
        $timestamps = [];
        foreach ( $this->ids as $id ) {
            $timestamps[] = $db->timestamp( $id );
        }
 
        $queryBuilder = $this->revisionStore->newArchiveSelectQueryBuilder( $db )
            ->joinComment()
            ->where( [
                'ar_namespace' => $this->getPage()->getNamespace(),
                'ar_title' => $this->getPage()->getDBkey(),
                'ar_timestamp' => $timestamps,
            ] )
            ->orderBy( 'ar_timestamp', SelectQueryBuilder::SORT_DESC );
 
        MediaWikiServices::getInstance()->getChangeTagsStore()->modifyDisplayQueryBuilder( $queryBuilder, 'archive' );
 
        return $queryBuilder->caller( __METHOD__ )->fetchResultSet();
    }
 
    public function newItem( $row ) {
        return new RevDelArchiveItem( $this, $row );
    }
 
    public function doPreCommitUpdates() {
        return Status::newGood();
    }
 
    public function doPostCommitUpdates( array $visibilityChangeMap ) {
        return Status::newGood();
    }
 
    protected function emitEvents(
        array $bitPars,
        array $visibilityChangeMap,
        array $tags,
        LogEntry $logEntry,
        bool $suppressed
    ) {
        // Do not emit PageHistoryVisibilityChangedEvent for archived revisions.
        // We could emit a ArchiveVisibilityChangedEvent in the future.
        // PageHistoryVisibilityChangedEvent and ArchiveVisibilityChangedEvent
        // should then share a base class, RevisionVisibilityChangedEvent.
    }
 
}
 
class_alias( RevDelArchiveList::class, 'RevDelArchiveList' );