includes/ImageGallery.php

   1 <?php
   2 if ( ! defined( 'MEDIAWIKI' ) )
   3         die( 1 );
   4
   5 /**
   6  * @package MediaWiki
   7  */
   8
   9 /**
  10  * Image gallery
  11  *
  12  * Add images to the gallery using add(), then render that list to HTML using toHTML().
  13  *
  14  * @package MediaWiki
  15  */
  16 class ImageGallery
  17 {
  18         var $mImages, $mShowBytes, $mShowFilename;
  19         var $mCaption = false;
  20         var $mSkin = false;
  21
  22         /**
  23          * Is the gallery on a wiki page (i.e. not a special page)
  24          */
  25         var $mParsing;
  26
  27         /**
  28          * Create a new image gallery object.
  29          */
  30         function ImageGallery( ) {
  31                 $this->mImages = array();
  32                 $this->mShowBytes = true;
  33                 $this->mShowFilename = true;
  34                 $this->mParsing = false;
  35         }
  36
  37         /**
  38          * Set the "parse" bit so we know to hide "bad" images
  39          */
  40         function setParsing( $val = true ) {
  41                 $this->mParsing = $val;
  42         }
  43
  44         /**
  45          * Set the caption
  46          *
  47          * @param $caption Caption
  48          */
  49         function setCaption( $caption ) {
  50                 $this->mCaption = $caption;
  51         }
  52
  53         /**
  54          * Instruct the class to use a specific skin for rendering
  55          *
  56          * @param $skin Skin object
  57          */
  58         function useSkin( &$skin ) {
  59                 $this->mSkin =& $skin;
  60         }
  61
  62         /**
  63          * Return the skin that should be used
  64          *
  65          * @return Skin object
  66          */
  67         function getSkin() {
  68                 if( !$this->mSkin ) {
  69                         global $wgUser;
  70                         $skin =& $wgUser->getSkin();
  71                 } else {
  72                         $skin =& $this->mSkin;
  73                 }
  74                 return $skin;
  75         }
  76
  77         /**
  78          * Add an image to the gallery.
  79          *
  80          * @param $image Image object that is added to the gallery
  81          * @param $html  String: additional HTML text to be shown. The name and size of the image are always shown.
  82          */
  83         function add( $image, $html='' ) {
  84                 $this->mImages[] = array( &$image, $html );
  85         }
  86
  87         /**
  88         * Add an image at the beginning of the gallery.
  89         *
  90         * @param $image Image object that is added to the gallery
  91         * @param $html  String:  Additional HTML text to be shown. The name and size of the image are always shown.
  92         */
  93         function insert( $image, $html='' ) {
  94                 array_unshift( $this->mImages, array( &$image, $html ) );
  95         }
  96
  97
  98         /**
  99          * isEmpty() returns true if the gallery contains no images
 100          */
 101         function isEmpty() {
 102                 return empty( $this->mImages );
 103         }
 104
 105         /**
 106          * Enable/Disable showing of the file size of an image in the gallery.
 107          * Enabled by default.
 108          *
 109          * @param $f Boolean: set to false to disable.
 110          */
 111         function setShowBytes( $f ) {
 112                 $this->mShowBytes = ( $f == true);
 113         }
 114
 115         /**
 116          * Enable/Disable showing of the filename of an image in the gallery.
 117          * Enabled by default.
 118          *
 119          * @param $f Boolean: set to false to disable.
 120          */
 121         function setShowFilename( $f ) {
 122                 $this->mShowFilename = ( $f == true);
 123         }
 124
 125         /**
 126          * Return a HTML representation of the image gallery
 127          *
 128          * For each image in the gallery, display
 129          * - a thumbnail
 130          * - the image name
 131          * - the additional text provided when adding the image
 132          * - the size of the image
 133          *
 134          */
 135         function toHTML() {
 136                 global $wgLang, $wgIgnoreImageErrors;
 137
 138                 $sk =& $this->getSkin();
 139
 140                 $s = '<table class="gallery" cellspacing="0" cellpadding="0">';
 141                 if( $this->mCaption )
 142                         $s .= '<td class="galleryheader" colspan="4"><big>' . htmlspecialchars( $this->mCaption ) . '</big></td>';
 143
 144                 $i = 0;
 145                 foreach ( $this->mImages as $pair ) {
 146                         $img =& $pair[0];
 147                         $text = $pair[1];
 148
 149                         $name = $img->getName();
 150                         $nt = $img->getTitle();
 151
 152                         # If we're dealing with a non-image, or a blacklisted image,
 153                         # spit out the name and be done with it
 154                         if( $nt->getNamespace() != NS_IMAGE
 155                                 || ( $this->mParsing && wfIsBadImage( $nt->getDBkey() ) ) ) {
 156                                 $s .=
 157                                         (($i%4==0) ? "<tr>\n" : '') .
 158                                         '<td><div class="gallerybox" style="height: 152px;">' .
 159                                         htmlspecialchars( $nt->getText() ) . '</div></td>' .
 160                                         (($i%4==3) ? "</tr>\n" : '');
 161                                 $i++;
 162
 163                                 continue;
 164                         }
 165
 166                         //TODO
 167                         //$ul = $sk->makeLink( $wgContLang->getNsText( Namespace::getUser() ) . ":{$ut}", $ut );
 168
 169                         if( $this->mShowBytes ) {
 170                                 if( $img->exists() ) {
 171                                         $nb = wfMsgExt( 'nbytes', array( 'parsemag', 'escape'),
 172                                                 $wgLang->formatNum( $img->getSize() ) );
 173                                 } else {
 174                                         $nb = wfMsgHtml( 'filemissing' );
 175                                 }
 176                                 $nb = "$nb<br />\n";
 177                         } else {
 178                                 $nb = '';
 179                         }
 180
 181                         $textlink = $this->mShowFilename ?
 182                                 $sk->makeKnownLinkObj( $nt, htmlspecialchars( $wgLang->truncate( $nt->getText(), 20, '...' ) ) ) . "<br />\n" :
 183                                 '' ;
 184
 185                         $s .= ($i%4==0) ? '<tr>' : '';
 186                         $thumb = $img->getThumbnail( 120, 120 );
 187                         if ( $thumb ) {
 188                                 $vpad = floor( ( 150 - $thumb->height ) /2 ) - 2;
 189                                 $s .= '<td><div class="gallerybox">' . '<div class="thumb" style="padding: ' . $vpad . 'px 0;">';
 190
 191                                 # ATTENTION: The newline after <div class="gallerytext"> is needed to accommodate htmltidy which
 192                                 # in version 4.8.6 generated crackpot html in its absence, see:
 193                                 # http://bugzilla.wikimedia.org/show_bug.cgi?id=1765 -Ævar
 194                                 $s .= $sk->makeKnownLinkObj( $nt, $thumb->toHtml() ) . '</div><div class="gallerytext">' . "\n" .
 195                                         $textlink . $text . $nb .
 196                                         '</div>';
 197                                 $s .= "</div></td>\n";
 198                         } else {
 199                                 # Error during thumbnail generation
 200                                 $s .= '<td><div class="gallerybox" style="height: 152px;">' .
 201                                         #htmlspecialchars( $nt->getText() ) . "<br />\n" .
 202                                         htmlspecialchars( $img->getLastError() ) .
 203                                         "</div><div class=\"gallerytext\">\n" .
 204                                         $textlink . $text . $nb .
 205                                         "</div></td>\n";
 206                         }
 207                         $s .= ($i%4==3) ? '</tr>' : '';
 208                         $i++;
 209                 }
 210                 if( $i %4 != 0 ) {
 211                         $s .= "</tr>\n";
 212                 }
 213                 $s .= '</table>';
 214
 215                 return $s;
 216         }
 217
 218 } //class
 219 ?>