includes/gallery/PackedOverlayImageGallery.php

   1 <?php
   2 /**
   3  * Packed overlay image gallery. All images adjusted to be same height and
   4  * image caption being placed over top of image.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @file
  22  */
  23
  24 class PackedOverlayImageGallery extends PackedImageGallery {
  25         /**
  26          * Add the wrapper html around the thumb's caption
  27          *
  28          * @param string $galleryText The caption
  29          * @param MediaTransformOutput|bool $thumb The thumb this caption is for
  30          *   or false for bad image.
  31          * @return string
  32          */
  33         protected function wrapGalleryText( $galleryText, $thumb ) {
  34
  35                 // If we have no text, do not output anything to avoid
  36                 // ugly white overlay.
  37                 if ( trim( $galleryText ) === '' ) {
  38                         return '';
  39                 }
  40
  41                 # ATTENTION: The newline after <div class="gallerytext"> is needed to
  42                 # accommodate htmltidy which in version 4.8.6 generated crackpot HTML
  43                 # in its absence, see: https://phabricator.wikimedia.org/T3765
  44                 # -Ævar
  45
  46                 $thumbWidth = $this->getGBWidth( $thumb ) - $this->getThumbPadding() - $this->getGBPadding();
  47                 $captionWidth = ceil( $thumbWidth - 20 );
  48
  49                 $outerWrapper = '<div class="gallerytextwrapper" style="width: ' . $captionWidth . 'px">';
  50
  51                 return "\n\t\t\t" . $outerWrapper . '<div class="gallerytext">' . "\n"
  52                         . $galleryText
  53                         . "\n\t\t\t</div></div>";
  54         }
  55 }
  56
  57 /**
  58  * Same as Packed except different CSS is applied to make the
  59  * caption only show up on hover. If a touch screen is detected,
  60  * falls back to PackedHoverGallery. Degrades gracefully for
  61  * screen readers.
  62  */
  63 class PackedHoverImageGallery extends PackedOverlayImageGallery {
  64 }