SlotDiffRenderer.php

Go to the documentation of this file.

<?php
use MediaWiki\Output\OutputPage;
use MediaWiki\Title\Title;
use Wikimedia\Assert\Assert;
 
abstract class SlotDiffRenderer {
 
    abstract public function getDiff( Content $oldContent = null, Content $newContent = null );
 
    public function localizeDiff( string $diff, array $options = [] ) {
        return $diff;
    }
 
    public function getTablePrefix( IContextSource $context, Title $newTitle ): array {
        return [];
    }
 
    public function addModules( OutputPage $output ) {
    }
 
    public function getExtraCacheKeys() {
        return [];
    }
 
    protected function normalizeContents(
        Content &$oldContent = null, Content &$newContent = null, $allowedClasses = null
    ) {
        if ( !$oldContent && !$newContent ) {
            throw new InvalidArgumentException( '$oldContent and $newContent cannot both be null' );
        }
 
        if ( $allowedClasses ) {
            if ( is_string( $allowedClasses ) ) {
                $allowedClasses = explode( '|', $allowedClasses );
            }
            $allowedClassesOrNull = array_merge( $allowedClasses, [ 'null' ] );
 
            // The new content (or the old one if the new one is null) must always match the renderer
            // since the ContentHandler of that model should be used to create it
            Assert::parameterType( $allowedClassesOrNull, $newContent, '$newContent' );
            if ( !$newContent ) {
                Assert::parameterType( $allowedClassesOrNull, $oldContent, '$oldContent' );
            }
 
            // If there are two content objects, the old one can be arbitrary as it is possible
            // to generate a diff between any two revisions; so an incompatible model should be
            // handled as a user error, not a logic error.
            if ( $oldContent && $newContent ) {
                $allowed = false;
                foreach ( $allowedClasses as $class ) {
                    if ( $oldContent instanceof $class ) {
                        $allowed = true;
                        break;
                    }
                }
                if ( !$allowed ) {
                    throw new IncompatibleDiffTypesException( $oldContent->getModel(), $newContent->getModel() );
                }
            }
        }
 
        if ( !$oldContent ) {
            $oldContent = $newContent->getContentHandler()->makeEmptyContent();
        } elseif ( !$newContent ) {
            $newContent = $oldContent->getContentHandler()->makeEmptyContent();
        }
    }
 
}