X-Git-Url: https://git.cyclocoop.org/%27.WWW_URL.%27admin/?a=blobdiff_plain;f=includes%2FImageGallery.php;h=a40a685223870c732572fc494d4c671e11f9e7d8;hb=39a2d2d42c9c0332a7acf8df32fbad18be9bd135;hp=f0aec768e2a9811a3d3e59f6006bc446d0c0251f;hpb=0bcdeea6a54b67118646d92d636327f120b759ae;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/ImageGallery.php b/includes/ImageGallery.php index f0aec768e2..a40a685223 100644 --- a/includes/ImageGallery.php +++ b/includes/ImageGallery.php @@ -2,22 +2,16 @@ if ( ! defined( 'MEDIAWIKI' ) ) die( 1 ); -/** - */ - /** * Image gallery * * Add images to the gallery using add(), then render that list to HTML using toHTML(). * - * @addtogroup Media + * @ingroup Media */ -class ImageGallery -{ +class ImageGallery { var $mImages, $mShowBytes, $mShowFilename; var $mCaption = false; - var $mSkin = false; - var $mRevisionId = 0; /** * Hide blacklisted images? @@ -26,6 +20,7 @@ class ImageGallery /** * Registered parser object for output callbacks + * @var Parser */ var $mParser; @@ -33,26 +28,38 @@ class ImageGallery * Contextual title, used when images are being screened * against the bad image list */ - private $contextTitle = false; + protected $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(); + protected $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->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 + * + * @param $parser Parser */ function setParser( $parser ) { $this->mParser = $parser; @@ -77,7 +84,7 @@ class ImageGallery /** * Set the caption (as HTML) * - * @param $caption Caption + * @param $caption String: Caption */ public function setCaptionHtml( $caption ) { $this->mCaption = $caption; @@ -86,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; } } @@ -97,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; } } @@ -108,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; } } @@ -120,56 +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 $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 $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='' ) { + function add( $title, $html = '', $alt = '' ) { if ( $title instanceof File ) { // Old calling convention $title = $title->getTitle(); } - $this->mImages[] = array( $title, $html ); - wfDebug( "ImageGallery::add " . $title->getText() . "\n" ); + $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. - */ - function insert( $title, $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 ) ); + array_unshift( $this->mImages, array( &$title, $html, $alt ) ); } - /** * isEmpty() returns true if the gallery contains no images */ @@ -184,7 +180,7 @@ class ImageGallery * @param $f Boolean: set to false to disable. */ function setShowBytes( $f ) { - $this->mShowBytes = ( $f == true); + $this->mShowBytes = (bool)$f; } /** @@ -194,17 +190,17 @@ 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 <table> 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 * @@ -355,5 +382,3 @@ class ImageGallery } } //class - -