From 4ac9fa081a7c045f6a9f1cfc529d82423f485b2e Mon Sep 17 00:00:00 2001 From: Pierre Schmitz Date: Sun, 8 Dec 2013 09:55:49 +0100 Subject: Update to MediaWiki 1.22.0 --- includes/gallery/ImageGalleryBase.php | 331 ++++++++++++++++++++++++++++++++++ 1 file changed, 331 insertions(+) create mode 100644 includes/gallery/ImageGalleryBase.php (limited to 'includes/gallery/ImageGalleryBase.php') diff --git a/includes/gallery/ImageGalleryBase.php b/includes/gallery/ImageGalleryBase.php new file mode 100644 index 00000000..f8b8c505 --- /dev/null +++ b/includes/gallery/ImageGalleryBase.php @@ -0,0 +1,331 @@ +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 ); + } + } + + /** + * Create a new image gallery object. + * + * You should not call this directly, but instead use + * ImageGalleryBase::factory(). + */ + 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; + } + + /** + * Register a parser object. If you do not set this + * and the output of this gallery ends up in parser + * cache, the javascript will break! + * + * @note This also triggers using the page's target + * language instead of the user language. + * + * @param $parser Parser + */ + function setParser( $parser ) { + $this->mParser = $parser; + } + + /** + * Set bad image flag + */ + function setHideBadImages( $flag = true ) { + $this->mHideBadImages = $flag; + } + + /** + * Set the caption (as plain text) + * + * @param string $caption Caption + */ + function setCaption( $caption ) { + $this->mCaption = htmlspecialchars( $caption ); + } + + /** + * Set the caption (as HTML) + * + * @param string $caption Caption + */ + public function setCaptionHtml( $caption ) { + $this->mCaption = $caption; + } + + /** + * Set how many images will be displayed per row. + * + * @param $num Integer >= 0; If perrow=0 the gallery layout will adapt to screensize + * invalid numbers will be rejected + */ + public function setPerRow( $num ) { + if ( $num >= 0 ) { + $this->mPerRow = (int)$num; + } + } + + /** + * Set how wide each image will be, in pixels. + * + * @param $num Integer > 0; invalid numbers will be ignored + */ + public function setWidths( $num ) { + if ( $num > 0 ) { + $this->mWidths = (int)$num; + } + } + + /** + * Set how high each image will be, in pixels. + * + * @param $num Integer > 0; invalid numbers will be ignored + */ + public function setHeights( $num ) { + if ( $num > 0 ) { + $this->mHeights = (int)$num; + } + } + + /** + * Allow setting additional options. This is meant + * to allow extensions to add additional parameters to + * parser tag. + * + * @param Array $options Attributes of gallery tag. + */ + public function setAdditionalOptions( $options ) { } + + /** + * Instruct the class to use a specific skin for rendering + * + * @param $skin Skin object + * @deprecated since 1.18 Not used anymore + */ + function useSkin( $skin ) { + wfDeprecated( __METHOD__, '1.18' ); + /* no op */ + } + + /** + * Add an image to the gallery. + * + * @param $title Title object of the image that is added to the gallery + * @param $html String: Additional HTML text to be shown. The name and size of the image are always shown. + * @param $alt String: Alt text for the image + * @param $link String: Override image link (optional) + * @param $handlerOpts Array: Array of options for image handler (aka page number) + */ + 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" ); + } + + /** + * Add an image at the beginning of the gallery. + * + * @param $title Title object of the image that is added to the gallery + * @param $html String: Additional HTML text to be shown. The name and size of the image are always shown. + * @param $alt String: Alt text for the image + * @param $link String: Override image link (optional) + * @param $handlerOpts Array: Array of options for image handler (aka page number) + */ + 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 ) ); + } + + /** + * isEmpty() returns true if the gallery contains no images + * @return bool + */ + function isEmpty() { + return empty( $this->mImages ); + } + + /** + * Enable/Disable showing of the file size of an image in the gallery. + * Enabled by default. + * + * @param $f Boolean: set to false to disable. + */ + function setShowBytes( $f ) { + $this->mShowBytes = (bool)$f; + } + + /** + * Enable/Disable showing of the filename of an image in the gallery. + * Enabled by default. + * + * @param $f Boolean: set to false to disable. + */ + function setShowFilename( $f ) { + $this->mShowFilename = (bool)$f; + } + + /** + * Set arbitrary attributes to go on the HTML gallery output element. + * Should be suitable for a