X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FImageGallery.php;h=31821d4a76a4aa7ab251e44098314f8062ee91d1;hb=1920363bde7d0199913d008ab0a7d796389ad5d1;hp=7f49a793b63a51b0080823e5e5553dba8ff7441c;hpb=9eda3649b791044862310f6f768322bedbb8952a;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/ImageGallery.php b/includes/ImageGallery.php index 7f49a793b6..31821d4a76 100644 --- a/includes/ImageGallery.php +++ b/includes/ImageGallery.php @@ -1,56 +1,177 @@ mImages = array(); - $this->mShowBytes = true; + $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']; + } + + /** + * Register a parser object + */ + function setParser( $parser ) { + $this->mParser = $parser; + } + + /** + * Set bad image flag + */ + function setHideBadImages( $flag = true ) { + $this->mHideBadImages = $flag; + } + + /** + * Set the caption (as plain text) + * + * @param $caption Caption + */ + function setCaption( $caption ) { + $this->mCaption = htmlspecialchars( $caption ); + } + + /** + * Set the caption (as HTML) + * + * @param $caption String: Caption + */ + public function setCaptionHtml( $caption ) { + $this->mCaption = $caption; } /** - * Add an image at the end of the gallery. + * Set how many images will be displayed per row. * - * @param Image $image Image object that is added to the gallery - * @param string $html Additional HTML text to be shown. The name and size of the image are always shown. + * @param $num Integer >= 0; If perrow=0 the gallery layout will adapt to screensize + * invalid numbers will be rejected */ - function add( $image, $html='' ) { - $this->mImages[] = array( &$image, $html ); + public function setPerRow( $num ) { + if ($num >= 0) { + $this->mPerRow = (int)$num; + } } - + /** - * Add an image at the beginning of the gallery. + * Set how wide each image will be, in pixels. * - * @param Image $image Image object that is added to the gallery - * @param string $html Additional HTML text to be shown. The name and size of the image are always shown. + * @param $num Integer > 0; invalid numbers will be ignored */ - function insert( $image, $html='' ) { - array_unshift( $this->mImages, array( &$image, $html ) ); + public function setWidths( $num ) { + if ($num > 0) { + $this->mWidths = (int)$num; + } } /** - * isEmpty() returns false iff the gallery doesn't contain any images + * 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; + } + } + + /** + * Instruct the class to use a specific skin for rendering + * + * @param $skin Skin object + */ + function useSkin( $skin ) { + $this->mSkin = $skin; + } + + /** + * Return the skin that should be used + * + * @return Skin object + */ + function getSkin() { + if( !$this->mSkin ) { + global $wgUser; + $skin = $wgUser->getSkin(); + } else { + $skin = $this->mSkin; + } + return $skin; + } + + /** + * 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. + */ + function add( $title, $html='' ) { + if ( $title instanceof File ) { + // Old calling convention + $title = $title->getTitle(); + } + $this->mImages[] = array( $title, $html ); + 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. + */ + function insert( $title, $html='' ) { + if ( $title instanceof File ) { + // Old calling convention + $title = $title->getTitle(); + } + array_unshift( $this->mImages, array( &$title, $html ) ); + } + + + /** + * isEmpty() returns true if the gallery contains no images */ function isEmpty() { return empty( $this->mImages ); @@ -59,26 +180,39 @@ class ImageGallery /** * Enable/Disable showing of the file size of an image in the gallery. * Enabled by default. - * - * @param boolean $f set to false to disable + * + * @param $f Boolean: set to false to disable. */ function setShowBytes( $f ) { - $this->mShowBytes = ( $f == true); + $this->mShowBytes = (bool)$f; } /** * Enable/Disable showing of the filename of an image in the gallery. * Enabled by default. - * - * @param boolean $f set to false to disable + * + * @param $f Boolean: set to false to disable. */ function setShowFilename( $f ) { - $this->mShowFilename = ( $f == true); + $this->mShowFilename = (bool)$f; + } + + /** + * Set arbitrary attributes to go on the HTML gallery output element. + * Should be suitable for a "; return $s; } -} //class - + /** + * @return Integer: number of images in the gallery + */ + public function count() { + return count( $this->mImages ); + } + /** + * Set the contextual title + * + * @param $title Title: contextual title + */ + public function setContextTitle( $title ) { + $this->contextTitle = $title; + } + /** + * Get the contextual title, if applicable + * + * @return mixed Title or false + */ + public function getContextTitle() { + return is_object( $this->contextTitle ) && $this->contextTitle instanceof Title + ? $this->contextTitle + : false; + } -} // defined( 'MEDIAWIKI' ) -?> +} //class