X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FImageGallery.php;h=5a8fb8e4f8fe8534edc6775ee9ef077fb897788f;hb=b59613ccade47b6c5447194c6ff3b9812a62d989;hp=86927c5b0e8ac4f60972ed7d23b5e8113c15805f;hpb=73be040a7af289f40ba95950ad57d64f8434b3a1;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/ImageGallery.php b/includes/ImageGallery.php index 86927c5b0e..5a8fb8e4f8 100644 --- a/includes/ImageGallery.php +++ b/includes/ImageGallery.php @@ -2,102 +2,173 @@ if ( ! defined( 'MEDIAWIKI' ) ) die( 1 ); -/** - * @package MediaWiki - */ - /** * Image gallery * * Add images to the gallery using add(), then render that list to HTML using toHTML(). * - * @package MediaWiki + * @ingroup Media */ -class ImageGallery -{ +class ImageGallery { var $mImages, $mShowBytes, $mShowFilename; var $mCaption = false; - var $mSkin = false; - + + /** + * Hide blacklisted images? + */ + var $mHideBadImages; + + /** + * Registered parser object for output callbacks + * @var Parser + */ + var $mParser; + + /** + * Contextual title, used when images are being screened + * against the bad image list + */ + protected $contextTitle = false; + + protected $mAttribs = array(); + /** - * Is the gallery on a wiki page (i.e. not a special page) + * Fixed margins */ - var $mParsing; + 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 ImageGallery( ) { + 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 the caption - * What's passed is used as HTML so don't do anything stupid + * Set bad image flag + */ + function setHideBadImages( $flag = true ) { + $this->mHideBadImages = $flag; + } + + /** + * Set the caption (as plain text) * - * @param $caption Caption + * @param $caption string Caption */ function setCaption( $caption ) { + $this->mCaption = htmlspecialchars( $caption ); + } + + /** + * Set the caption (as HTML) + * + * @param $caption String: Caption + */ + public function setCaptionHtml( $caption ) { $this->mCaption = $caption; } /** - * Instruct the class to use a specific skin for rendering + * Set how many images will be displayed per row. * - * @param $skin Skin object + * @param $num Integer >= 0; If perrow=0 the gallery layout will adapt to screensize + * invalid numbers will be rejected */ - function useSkin( &$skin ) { - $this->mSkin =& $skin; + public function setPerRow( $num ) { + if ( $num >= 0 ) { + $this->mPerRow = (int)$num; + } } - + /** - * Return the skin that should be used + * Set how wide each image will be, in pixels. * - * @return Skin object + * @param $num Integer > 0; invalid numbers will be ignored */ - function getSkin() { - if( !$this->mSkin ) { - global $wgUser; - $skin =& $wgUser->getSkin(); - } else { - $skin =& $this->mSkin; + public function setWidths( $num ) { + if ( $num > 0 ) { + $this->mWidths = (int)$num; } - return $skin; } /** - * Add an image to the gallery. + * 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 $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 $skin Skin object + * @deprecated since 1.18 Not used anymore */ - function add( $image, $html='' ) { - $this->mImages[] = array( &$image, $html ); + function useSkin( $skin ) { + wfDeprecated( __METHOD__, '1.18' ); + /* no op */ } /** - * 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 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 + */ + 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 $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 + * @return bool */ function isEmpty() { return empty( $this->mImages ); @@ -110,7 +181,7 @@ class ImageGallery * @param $f Boolean: set to false to disable. */ function setShowBytes( $f ) { - $this->mShowBytes = ( $f == true); + $this->mShowBytes = (bool)$f; } /** @@ -120,7 +191,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 $output; + } + + /** + * @return Integer: number of images in the gallery + */ + public function count() { + return count( $this->mImages ); + } - return $s; + /** + * 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; } } //class -?>