includes/gallery/PackedImageGallery.php

   1 <?php
   2 /**
   3  * Packed image gallery. All images adjusted to be same height.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 class PackedImageGallery extends TraditionalImageGallery {
  24
  25         /**
  26          * We artificially have 1.5 the resolution neccessary so that
  27          * we can scale it up by that much on the client side, without
  28          * worrying about requesting a new image.
  29          */
  30         const SCALE_FACTOR = 1.5;
  31
  32         protected function getVPad( $boxHeight, $thumbHeight ) {
  33                 return ( $this->getThumbPadding() + $boxHeight - $thumbHeight/ self::SCALE_FACTOR ) / 2;
  34         }
  35
  36         protected function getThumbPadding() {
  37                 return 0;
  38         }
  39
  40         protected function getGBPadding() {
  41                 return 2;
  42         }
  43
  44         /**
  45          * @param File $img The file being transformed. May be false
  46          */
  47         protected function getThumbParams( $img ) {
  48                 if ( $img && $img->getMediaType() === MEDIATYPE_AUDIO ) {
  49                         $width = $this->mWidths;
  50                 } else {
  51                         // We want the width not to be the constraining
  52                         // factor, so use random big number.
  53                         $width = $this->mHeights * 10 + 100;
  54                 }
  55                 // self::SCALE_FACTOR so the js has some room to manipulate sizes.
  56                 return array(
  57                         'width' => $width * self::SCALE_FACTOR,
  58                         'height' => $this->mHeights * self::SCALE_FACTOR,
  59                 );
  60         }
  61
  62         protected function getThumbDivWidth( $thumbWidth ) {
  63                 // Require at least 60px wide, so caption is wide enough to work.
  64                 if ( $thumbWidth < 60 * self::SCALE_FACTOR ) {
  65                         $thumbWidth = 60 * self::SCALE_FACTOR;
  66                 }
  67                 return $thumbWidth / self::SCALE_FACTOR + $this->getThumbPadding();
  68         }
  69
  70         /**
  71          * @param MediaTransformOutput|bool $thumb the thumbnail, or false if no thumb (which can happen)
  72          */
  73         protected function getGBWidth( $thumb ) {
  74                 $thumbWidth = $thumb ? $thumb->getWidth() : $this->mWidths * self::SCALE_FACTOR;
  75                 return $this->getThumbDivWidth( $thumbWidth ) + $this->getGBPadding();
  76         }
  77
  78         protected function adjustImageParameters( $thumb, &$imageParameters ) {
  79                 // Re-adjust back to normal size.
  80                 $imageParameters['override-width'] = ceil( $thumb->getWidth() / self::SCALE_FACTOR );
  81                 $imageParameters['override-height'] = ceil( $thumb->getHeight() / self::SCALE_FACTOR );
  82         }
  83
  84         /**
  85          * Add javascript which auto-justifies the rows by manipulating the image sizes.
  86          * Also ensures that the hover version of this degrades gracefully.
  87          */
  88         protected function getModules() {
  89                 return array( 'mediawiki.page.gallery' );
  90         }
  91 }