X-Git-Url: http://git.cyclocoop.org/?a=blobdiff_plain;f=includes%2FImageGallery.php;h=4d5f067ca7dcd23bfab19f5d4cccfbfa1b37b7ad;hb=537a6eb680b3f7ea9c8eb0c740ae3a02bd64678f;hp=c9eb96a0298ec0b6f5ba83fafc63a0cec7b0f50b;hpb=b672f737ab1f173714f45a06856419c4e9c12f4a;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/ImageGallery.php b/includes/ImageGallery.php index c9eb96a029..4d5f067ca7 100644 --- a/includes/ImageGallery.php +++ b/includes/ImageGallery.php @@ -2,25 +2,27 @@ if ( ! defined( 'MEDIAWIKI' ) ) die( 1 ); -/** - */ - /** * Image gallery * * Add images to the gallery using add(), then render that list to HTML using toHTML(). * + * @ingroup Media */ -class ImageGallery -{ +class ImageGallery { var $mImages, $mShowBytes, $mShowFilename; var $mCaption = false; - var $mSkin = false; /** - * Is the gallery on a wiki page (i.e. not a special page) + * Hide blacklisted images? + */ + var $mHideBadImages; + + /** + * Registered parser object for output callbacks + * @var Parser */ - var $mParsing; + var $mParser; /** * Contextual title, used when images are being screened @@ -28,24 +30,46 @@ class ImageGallery */ private $contextTitle = false; - private $mPerRow = 4; // How many images wide should the gallery be? - private $mWidths = 120, $mHeights = 120; // How wide/tall each thumbnail should be + private $mAttribs = array(); + + /** + * Fixed margins + */ + const THUMB_PADDING = 30; + const GB_PADDING = 5; + // 2px borders on each side + 2px implied padding on each side + const GB_BORDERS = 8; /** * Create a new image gallery object. */ - function __construct( ) { + function __construct() { + global $wgGalleryOptions; $this->mImages = array(); - $this->mShowBytes = true; + $this->mShowBytes = $wgGalleryOptions['showBytes']; $this->mShowFilename = true; - $this->mParsing = false; + $this->mParser = false; + $this->mHideBadImages = false; + $this->mPerRow = $wgGalleryOptions['imagesPerRow']; + $this->mWidths = $wgGalleryOptions['imageWidth']; + $this->mHeights = $wgGalleryOptions['imageHeight']; + $this->mCaptionLength = $wgGalleryOptions['captionLength']; } /** - * Set the "parse" bit so we know to hide "bad" images + * Register a parser object + * + * @param $parser Parser */ - function setParsing( $val = true ) { - $this->mParsing = $val; + function setParser( $parser ) { + $this->mParser = $parser; + } + + /** + * Set bad image flag + */ + function setHideBadImages( $flag = true ) { + $this->mHideBadImages = $flag; } /** @@ -60,7 +84,7 @@ class ImageGallery /** * Set the caption (as HTML) * - * @param $caption Caption + * @param $caption String: Caption */ public function setCaptionHtml( $caption ) { $this->mCaption = $caption; @@ -69,10 +93,11 @@ class ImageGallery /** * Set how many images will be displayed per row. * - * @param int $num > 0; invalid numbers will be rejected + * @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) { + if ( $num >= 0 ) { $this->mPerRow = (int)$num; } } @@ -80,10 +105,10 @@ class ImageGallery /** * Set how wide each image will be, in pixels. * - * @param int $num > 0; invalid numbers will be ignored + * @param $num Integer > 0; invalid numbers will be ignored */ public function setWidths( $num ) { - if ($num > 0) { + if ( $num > 0 ) { $this->mWidths = (int)$num; } } @@ -91,10 +116,10 @@ class ImageGallery /** * Set how high each image will be, in pixels. * - * @param int $num > 0; invalid numbers will be ignored + * @param $num Integer > 0; invalid numbers will be ignored */ public function setHeights( $num ) { - if ($num > 0) { + if ( $num > 0 ) { $this->mHeights = (int)$num; } } @@ -103,48 +128,44 @@ class ImageGallery * Instruct the class to use a specific skin for rendering * * @param $skin Skin object + * @deprecated since 1.18 Not used anymore */ 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; + wfDeprecated( __METHOD__ ); + /* no op */ } /** * Add an image to the gallery. * - * @param $image Image object 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 $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 */ - function add( $image, $html='' ) { - $this->mImages[] = array( &$image, $html ); - wfDebug( "ImageGallery::add " . $image->getName() . "\n" ); + function add( $title, $html = '', $alt = '' ) { + if ( $title instanceof File ) { + // Old calling convention + $title = $title->getTitle(); + } + $this->mImages[] = array( $title, $html, $alt ); + wfDebug( 'ImageGallery::add ' . $title->getText() . "\n" ); } /** - * Add an image at the beginning of the gallery. - * - * @param $image Image object 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( $image, $html='' ) { - array_unshift( $this->mImages, array( &$image, $html ) ); + * 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 + */ + function insert( $title, $html = '', $alt = '' ) { + if ( $title instanceof File ) { + // Old calling convention + $title = $title->getTitle(); + } + array_unshift( $this->mImages, array( &$title, $html, $alt ) ); } - /** * isEmpty() returns true if the gallery contains no images */ @@ -159,7 +180,7 @@ class ImageGallery * @param $f Boolean: set to false to disable. */ function setShowBytes( $f ) { - $this->mShowBytes = ( $f == true); + $this->mShowBytes = (bool)$f; } /** @@ -169,7 +190,20 @@ class ImageGallery * @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; + return $output; } /** - * @return int Number of images in the gallery + * @return Integer: number of images in the gallery */ public function count() { return count( $this->mImages ); } - + /** * Set the contextual title * - * @param Title $title Contextual title + * @param $title Title: contextual title */ public function setContextTitle( $title ) { $this->contextTitle = $title; } - + /** * Get the contextual title, if applicable * @@ -290,4 +382,3 @@ class ImageGallery } } //class -?>