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
23class PackedImageGallery extends TraditionalImageGallery {
24	public function __construct( $mode = 'traditional', IContextSource $context = null ) {
25		parent::__construct( $mode, $context );
26		// Does not support per row option.
27		$this->mPerRow = 0;
28	}
29
30	/**
31	 * We artificially have 1.5 the resolution necessary so that
32	 * we can scale it up by that much on the client side, without
33	 * worrying about requesting a new image.
34	 */
35	private const SCALE_FACTOR = 1.5;
36
37	protected function getVPad( $boxHeight, $thumbHeight ) {
38		return ( $this->getThumbPadding() + $boxHeight - $thumbHeight / self::SCALE_FACTOR ) / 2;
39	}
40
41	protected function getThumbPadding() {
42		return 0;
43	}
44
45	protected function getGBPadding() {
46		return 2;
47	}
48
49	/**
50	 * @param File $img The file being transformed. May be false
51	 * @return array
52	 */
53	protected function getThumbParams( $img ) {
54		if ( $img && $img->getMediaType() === MEDIATYPE_AUDIO ) {
55			$width = $this->mWidths;
56		} else {
57			// We want the width not to be the constraining
58			// factor, so use random big number.
59			$width = $this->mHeights * 10 + 100;
60		}
61
62		// self::SCALE_FACTOR so the js has some room to manipulate sizes.
63		return [
64			'width' => $width * self::SCALE_FACTOR,
65			'height' => $this->mHeights * self::SCALE_FACTOR,
66		];
67	}
68
69	protected function getThumbDivWidth( $thumbWidth ) {
70		// Require at least 60px wide, so caption is wide enough to work.
71		if ( $thumbWidth < 60 * self::SCALE_FACTOR ) {
72			$thumbWidth = 60 * self::SCALE_FACTOR;
73		}
74
75		return $thumbWidth / self::SCALE_FACTOR + $this->getThumbPadding();
76	}
77
78	/**
79	 * @param MediaTransformOutput|bool $thumb The thumbnail, or false if no
80	 *   thumb (which can happen)
81	 * @return float
82	 */
83	protected function getGBWidth( $thumb ) {
84		$thumbWidth = $thumb ? $thumb->getWidth() : $this->mWidths * self::SCALE_FACTOR;
85
86		return $this->getThumbDivWidth( $thumbWidth ) + $this->getGBPadding();
87	}
88
89	protected function adjustImageParameters( $thumb, &$imageParameters ) {
90		// Re-adjust back to normal size.
91		$imageParameters['override-width'] = ceil( $thumb->getWidth() / self::SCALE_FACTOR );
92		$imageParameters['override-height'] = ceil( $thumb->getHeight() / self::SCALE_FACTOR );
93	}
94
95	/**
96	 * Add javascript which auto-justifies the rows by manipulating the image sizes.
97	 * Also ensures that the hover version of this degrades gracefully.
98	 * @return array
99	 */
100	protected function getModules() {
101		return [ 'mediawiki.page.gallery' ];
102	}
103
104	/**
105	 * Do not support per-row on packed. It really doesn't work
106	 * since the images have varying widths.
107	 * @param int $num
108	 */
109	public function setPerRow( $num ) {
110	}
111}
112