X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FImageGallery.php;h=62f9eedb36c443ee5366293ab650b81ec6ca4c06;hb=86df2d275521184e42f30254724da2b0483ad421;hp=cfbc6ead3226e0334a3cf56a1f9bd503bec02c35;hpb=d03c0c2c6b89203c6ededcb2893b1ec3d83e6fdc;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/ImageGallery.php b/includes/ImageGallery.php index cfbc6ead32..62f9eedb36 100644 --- a/includes/ImageGallery.php +++ b/includes/ImageGallery.php @@ -2,49 +2,68 @@ 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 { var $mImages, $mShowBytes, $mShowFilename; var $mCaption = false; var $mSkin = false; - + var $mRevisionId = 0; + /** - * Is the gallery on a wiki page (i.e. not a special page) + * Hide blacklisted images? */ - var $mParsing; - + var $mHideBadImages; + + /** + * Registered parser object for output callbacks + */ + var $mParser; + /** * Contextual title, used when images are being screened * against the bad image list */ private $contextTitle = false; + private $mAttribs = array(); + /** * Create a new image gallery object. */ 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 */ - function setParsing( $val = true ) { - $this->mParsing = $val; + function setParser( $parser ) { + $this->mParser = $parser; } - + + /** + * Set bad image flag + */ + function setHideBadImages( $flag = true ) { + $this->mHideBadImages = $flag; + } + /** * Set the caption (as plain text) * @@ -53,25 +72,59 @@ class ImageGallery function setCaption( $caption ) { $this->mCaption = htmlspecialchars( $caption ); } - + /** * Set the caption (as HTML) * - * @param $caption Caption + * @param $caption String: Caption */ - function setCaptionHtml( $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; + } + } + /** * Instruct the class to use a specific skin for rendering * * @param $skin Skin object */ function useSkin( $skin ) { - $this->mSkin =& $skin; + $this->mSkin = $skin; } - + /** * Return the skin that should be used * @@ -80,9 +133,9 @@ class ImageGallery function getSkin() { if( !$this->mSkin ) { global $wgUser; - $skin =& $wgUser->getSkin(); + $skin = $wgUser->getSkin(); } else { - $skin =& $this->mSkin; + $skin = $this->mSkin; } return $skin; } @@ -90,22 +143,30 @@ class ImageGallery /** * 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. */ - function add( $image, $html='' ) { - $this->mImages[] = array( &$image, $html ); - wfDebug( "ImageGallery::add " . $image->getName() . "\n" ); + 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 $image Image object that is added 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 insert( $image, $html='' ) { - array_unshift( $this->mImages, array( &$image, $html ) ); + function insert( $title, $html='' ) { + if ( $title instanceof File ) { + // Old calling convention + $title = $title->getTitle(); + } + array_unshift( $this->mImages, array( &$title, $html ) ); } @@ -123,7 +184,7 @@ class ImageGallery * @param $f Boolean: set to false to disable. */ function setShowBytes( $f ) { - $this->mShowBytes = ( $f == true); + $this->mShowBytes = (bool)$f; } /** @@ -133,7 +194,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 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 * @@ -245,4 +377,3 @@ class ImageGallery } } //class -?>