ImageGalleryBase.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;

abstract class ImageGalleryBase extends ContextSource {
    protected $mImages;

    protected $mShowBytes;

    protected $mShowDimensions;

    protected $mShowFilename;

    protected $mMode;

    protected $mCaption = false;

    protected $mCaptionLength = true;

    protected $mHideBadImages;

    public $mParser;

    protected $contextTitle = false;

    protected $mAttribs = [];

    private static $modeMapping = false;

    static function factory( $mode = false, IContextSource $context = null ) {
        self::loadModes();
        if ( !$context ) {
            $context = RequestContext::getMainAndWarn( __METHOD__ );
        }
        if ( !$mode ) {
            $galleryOptions = $context->getConfig()->get( '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 MWException( "No gallery class registered for mode $mode" );
        }
    }

    private static function loadModes() {
        if ( self::$modeMapping === false ) {
            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.
            Hooks::run( 'GalleryGetModes', [ &self::$modeMapping ] );
        }
    }

    function __construct( $mode = 'traditional', IContextSource $context = null ) {
        if ( $context ) {
            $this->setContext( $context );
        }

        $galleryOptions = $this->getConfig()->get( '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;
    }

    function setParser( $parser ) {
        $this->mParser = $parser;
    }

    function setHideBadImages( $flag = true ) {
        $this->mHideBadImages = $flag;
    }

    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 ) {
        $parsed = Parser::parseWidthParam( $num, false );
        if ( isset( $parsed['width'] ) && $parsed['width'] > 0 ) {
            $this->mWidths = $parsed['width'];
        }
    }

    public function setHeights( $num ) {
        $parsed = Parser::parseWidthParam( $num, false );
        if ( isset( $parsed['width'] ) && $parsed['width'] > 0 ) {
            $this->mHeights = $parsed['width'];
        }
    }

    public function setAdditionalOptions( $options ) {
    }

    function add( $title, $html = '', $alt = '', $link = '', $handlerOpts = [] ) {
        if ( $title instanceof File ) {
            // Old calling convention
            $title = $title->getTitle();
        }
        $this->mImages[] = [ $title, $html, $alt, $link, $handlerOpts ];
        wfDebug( 'ImageGallery::add ' . $title->getText() . "\n" );
    }

    function insert( $title, $html = '', $alt = '', $link = '', $handlerOpts = [] ) {
        if ( $title instanceof File ) {
            // Old calling convention
            $title = $title->getTitle();
        }
        array_unshift( $this->mImages, [ &$title, $html, $alt, $link, $handlerOpts ] );
    }

    public function getImages() {
        return $this->mImages;
    }

    function isEmpty() {
        return empty( $this->mImages );
    }

    function setShowDimensions( $f ) {
        $this->mShowDimensions = (bool)$f;
    }

    function setShowBytes( $f ) {
        $this->mShowBytes = (bool)$f;
    }

    function setShowFilename( $f ) {
        $this->mShowFilename = (bool)$f;
    }

    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 is_object( $this->contextTitle ) && $this->contextTitle instanceof Title
            ? $this->contextTitle
            : false;
    }

    protected function getRenderLang() {
        return $this->mParser
            ? $this->mParser->getTargetLanguage()
            : $this->getLanguage();
    }
}