Tell regexp parser to use extra analysis on external link regexp;
[lhc/web/wiklou.git] / includes / ImageGallery.php
index d29cf0d..7a8c6e0 100644 (file)
@@ -1,4 +1,3 @@
-
 <?php
 /**
  * @package MediaWiki
@@ -12,20 +11,71 @@ if( defined( 'MEDIAWIKI' ) ) {
 
 /**
  * Image gallery
+ * 
+ * Add images to the gallery using add(), then render that list to HTML using toHTML().
+ *
  * @package MediaWiki
  */
 class ImageGallery
 {
-       var $mImages;
+       var $mImages, $mShowBytes, $mShowFilename;
 
+       /** 
+        * Create a new image gallery object.
+        */
        function ImageGallery( ) {
-               $this->mImages=array();
+               $this->mImages = array();
+               $this->mShowBytes = true;
+               $this->mShowFilename = true;
        }
 
+       /**
+        * Add an image to the gallery.
+        *
+        * @param Image  $image  Image object that is added to the gallery
+        * @param string $text   Additional text to be shown. The name and size of the image are always shown.
+        */
        function add( $image, $text='' ) {
                $this->mImages[] = array( &$image, $text );
        }
 
+       /**
+        * isEmpty() returns false iff the gallery doesn't contain any images
+        */
+       function isEmpty() {
+               return empty( $this->mImages );
+       }
+
+       /**
+        * Enable/Disable showing of the file size of an image in the gallery.
+        * Enabled by default.
+        * 
+        * @param boolean $f    set to false to disable
+        */
+       function setShowBytes( $f ) {
+               $this->mShowBytes = ( $f == true);
+       }
+
+       /**
+        * Enable/Disable showing of the filename of an image in the gallery.
+        * Enabled by default.
+        * 
+        * @param boolean $f    set to false to disable
+        */
+       function setShowFilename( $f ) {
+               $this->mShowFilename = ( $f == true);
+       }
+
+       /**
+        * Return a HTML representation of the image gallery
+        * 
+        * For each image in the gallery, display
+        * - a thumbnail
+        * - the image name
+        * - the additional text provided when adding the image
+        * - the size of the image
+        *
+        */
        function toHTML() {
                global $wgLang, $wgContLang, $wgUser;
 
@@ -43,16 +93,19 @@ class ImageGallery
                        //TODO
                        //$ul = $sk->makeLink( $wgContLang->getNsText( Namespace::getUser() ) . ":{$ut}", $ut );
 
-                       $ilink = '<a href="' . $img->getURL() .  '">' . $nt->getText() . '</a>';
-                       $nb = wfMsg( "nbytes", $wgLang->formatNum( $img->getSize() ) );
+                       $nb = $this->mShowBytes ? 
+                               wfMsg( "nbytes", $wgLang->formatNum( $img->getSize() ) )  . '<br />' :
+                               '' ;
+                       $textlink = $this->mShowFilename ?
+                               $sk->makeKnownLinkObj( $nt, Language::truncate( $nt->getText(), 20, '...' ) ) . '<br />' :
+                               '' ;
 
                        $s .= ($i%4==0) ? '<tr>' : '';
                        $s .= '<td valign="top" width="150px" style="background-color:#F0F0F0;">' .
                                '<table width="100%" height="150px">'.
                                '<tr><td align="center" valign="center" style="background-color:#F8F8F8;border:solid 1px #888888;">' .
-                               '<img  src="'.$img->createThumb(120,120).'" alt=""></td></tr></table> ' .
-                               '(' .  $sk->makeKnownLinkObj( $nt, wfMsg( "imgdesc" ) ) .
-                               ") {$ilink}<br />{$text}{$nb}<br />" ;
+                               $sk->makeKnownLinkObj( $nt, '<img  src="'.$img->createThumb(120,120).'" alt="">' ) . '</td></tr></table> ' .
+                               $textlink . $text . $nb; 
 
                        $s .= '</td>' .  (($i%4==3) ? '</tr>' : '');