ImageGalleryBase.php

Go to the documentation of this file.

<?php
abstract class ImageGalleryBase extends ContextSource {
    var $mImages, $mShowBytes, $mShowFilename, $mMode;
    var $mCaption = false;

    var $mHideBadImages;

    var $mParser;

    protected $contextTitle = false;

    protected $mAttribs = array();

    static private $modeMapping = false;

    static function factory( $mode = false ) {
        global $wgGalleryOptions, $wgContLang;
        self::loadModes();
        if ( !$mode ) {
            $mode = $wgGalleryOptions['mode'];
        }

        $mode = $wgContLang->lc( $mode );

        if ( isset( self::$modeMapping[$mode] ) ) {
            return new self::$modeMapping[$mode]( $mode );
        } else {
            throw new MWException( "No gallery class registered for mode $mode" );
        }
    }

    static private function loadModes() {
        if ( self::$modeMapping === false ) {
            self::$modeMapping = array(
                'traditional' => 'TraditionalImageGallery',
                'nolines' => 'NolinesImageGallery',
                'packed' => 'PackedImageGallery',
                'packed-hover' => 'PackedHoverImageGallery',
                'packed-overlay' => 'PackedOverlayImageGallery',
            );
            // Allow extensions to make a new gallery format.
            wfRunHooks( 'GalleryGetModes', self::$modeMapping );
        }
    }

    function __construct( $mode = 'traditional' ) {
        global $wgGalleryOptions;
        $this->mImages = array();
        $this->mShowBytes = $wgGalleryOptions['showBytes'];
        $this->mShowFilename = true;
        $this->mParser = false;
        $this->mHideBadImages = false;
        $this->mPerRow = $wgGalleryOptions['imagesPerRow'];
        $this->mWidths = $wgGalleryOptions['imageWidth'];
        $this->mHeights = $wgGalleryOptions['imageHeight'];
        $this->mCaptionLength = $wgGalleryOptions['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 ) {
        if ( $num > 0 ) {
            $this->mWidths = (int)$num;
        }
    }

    public function setHeights( $num ) {
        if ( $num > 0 ) {
            $this->mHeights = (int)$num;
        }
    }

    public function setAdditionalOptions( $options ) { }

    function useSkin( $skin ) {
        wfDeprecated( __METHOD__, '1.18' );
        /* no op */
    }

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

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

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

    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();
    }

    /* Old constants no longer used.
    const THUMB_PADDING = 30;
    const GB_PADDING = 5;
    const GB_BORDERS = 8;
    */

}