ImageGalleryBase.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Gallery;
 
use ImageGalleryClassNotFoundException;
use MediaWiki\Context\ContextSource;
use MediaWiki\Context\IContextSource;
use MediaWiki\Context\RequestContext;
use MediaWiki\FileRepo\File\File;
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\Language\Language;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Parser\Parser;
use MediaWiki\Title\Title;
 
abstract class ImageGalleryBase extends ContextSource {
    public const LOADING_DEFAULT = 1;
    public const LOADING_LAZY = 2;
 
    protected $mImages;
 
    protected $mShowBytes;
 
    protected $mShowDimensions;
 
    protected $mShowFilename;
 
    protected $mMode;
 
    protected $mCaption = false;
 
    protected $mCaptionLength = true;
 
    protected $mHideBadImages;
 
    public $mParser;
 
    protected $contextTitle = null;
 
    protected $mAttribs = [];
 
    protected $mPerRow;
 
    protected $mWidths;
 
    protected $mHeights;
 
    private static $modeMapping;
 
    public static function factory( $mode = false, ?IContextSource $context = null ) {
        self::loadModes();
        if ( !$context ) {
            $context = RequestContext::getMainAndWarn( __METHOD__ );
        }
        if ( !$mode ) {
            $galleryOptions = $context->getConfig()->get( MainConfigNames::GalleryOptions );
            $mode = $galleryOptions['mode'];
        }
 
        $mode = MediaWikiServices::getInstance()->getContentLanguage()->lc( $mode );
 
        if ( isset( self::$modeMapping[$mode] ) ) {
            $class = self::$modeMapping[$mode];
            return new $class( $mode, $context );
        } else {
            throw new ImageGalleryClassNotFoundException( "No gallery class registered for mode $mode" );
        }
    }
 
    private static function loadModes() {
        if ( self::$modeMapping === null ) {
            self::$modeMapping = [
                'traditional' => TraditionalImageGallery::class,
                'nolines' => NolinesImageGallery::class,
                'packed' => PackedImageGallery::class,
                'packed-hover' => PackedHoverImageGallery::class,
                'packed-overlay' => PackedOverlayImageGallery::class,
                'slideshow' => SlideshowImageGallery::class,
            ];
            // Allow extensions to make a new gallery format.
            ( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) )
                ->onGalleryGetModes( self::$modeMapping );
        }
    }
 
    public function __construct( $mode = 'traditional', ?IContextSource $context = null ) {
        if ( $context ) {
            $this->setContext( $context );
        }
 
        $galleryOptions = $this->getConfig()->get( MainConfigNames::GalleryOptions );
        $this->mImages = [];
        $this->mShowBytes = $galleryOptions['showBytes'];
        $this->mShowDimensions = $galleryOptions['showDimensions'];
        $this->mShowFilename = true;
        $this->mParser = false;
        $this->mHideBadImages = false;
        $this->mPerRow = $galleryOptions['imagesPerRow'];
        $this->mWidths = $galleryOptions['imageWidth'];
        $this->mHeights = $galleryOptions['imageHeight'];
        $this->mCaptionLength = $galleryOptions['captionLength'];
        $this->mMode = $mode;
    }
 
    public function setParser( $parser ) {
        $this->mParser = $parser;
    }
 
    public function setHideBadImages( $flag = true ) {
        $this->mHideBadImages = $flag;
    }
 
    public function setCaption( $caption ) {
        $this->mCaption = htmlspecialchars( $caption );
    }
 
    public function setCaptionHtml( $caption ) {
        $this->mCaption = $caption;
    }
 
    public function setPerRow( $num ) {
        if ( $num >= 0 ) {
            $this->mPerRow = (int)$num;
        }
    }
 
    public function setWidths( $num ) {
        $parser = $this->mParser;
        if ( !$parser ) {
            wfDeprecated( __METHOD__ . ' without parser', '1.43' );
            $parser = MediaWikiServices::getInstance()->getParser();
        }
        $parsed = $parser->parseWidthParam( $num, false );
        if ( isset( $parsed['width'] ) && $parsed['width'] > 0 ) {
            $this->mWidths = $parsed['width'];
        }
    }
 
    public function setHeights( $num ) {
        $parser = $this->mParser;
        if ( !$parser ) {
            wfDeprecated( __METHOD__ . ' without parser', '1.43' );
            $parser = MediaWikiServices::getInstance()->getParser();
        }
        $parsed = $parser->parseWidthParam( $num, false );
        if ( isset( $parsed['width'] ) && $parsed['width'] > 0 ) {
            $this->mHeights = $parsed['width'];
        }
    }
 
    public function setAdditionalOptions( $options ) {
    }
 
    public function add(
        $title,
        $html = '',
        $alt = '',
        $link = '',
        $handlerOpts = [],
        $loading = self::LOADING_DEFAULT,
        ?array $imageOptions = null
    ) {
        if ( $title instanceof File ) {
            // Old calling convention
            $title = $title->getTitle();
        }
        $this->mImages[] = [ $title, $html, $alt, $link, $handlerOpts, $loading, $imageOptions ];
        wfDebug( 'ImageGallery::add ' . $title->getText() );
    }
 
    public function insert(
        $title,
        $html = '',
        $alt = '',
        $link = '',
        $handlerOpts = [],
        $loading = self::LOADING_DEFAULT,
        ?array $imageOptions = null
    ) {
        if ( $title instanceof File ) {
            // Old calling convention
            $title = $title->getTitle();
        }
        array_unshift( $this->mImages, [ $title, $html, $alt, $link, $handlerOpts, $loading, $imageOptions ] );
    }
 
    public function getImages() {
        return $this->mImages;
    }
 
    public function isEmpty() {
        return $this->mImages === [];
    }
 
    public function setShowDimensions( $f ) {
        $this->mShowDimensions = (bool)$f;
    }
 
    public function setShowBytes( $f ) {
        $this->mShowBytes = (bool)$f;
    }
 
    public function setShowFilename( $f ) {
        $this->mShowFilename = (bool)$f;
    }
 
    public function setAttributes( $attribs ) {
        $this->mAttribs = $attribs;
    }
 
    abstract public function toHTML();
 
    public function count() {
        return count( $this->mImages );
    }
 
    public function setContextTitle( $title ) {
        $this->contextTitle = $title;
    }
 
    public function getContextTitle() {
        return $this->contextTitle;
    }
 
    protected function getRenderLang() {
        return $this->mParser
            ? $this->mParser->getTargetLanguage()
            : $this->getLanguage();
    }
}
 
class_alias( ImageGalleryBase::class, 'ImageGalleryBase' );