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.
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.
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
23 class TraditionalImageGallery
extends ImageGalleryBase
{
25 * Return a HTML representation of the image gallery
27 * For each image in the gallery, display
30 * - the additional text provided when adding the image
31 * - the size of the image
36 if ( $this->mPerRow
> 0 ) {
37 $maxwidth = $this->mPerRow
* ( $this->mWidths +
$this->getAllPadding() );
38 $oldStyle = isset( $this->mAttribs
['style'] ) ?
$this->mAttribs
['style'] : '';
39 # _width is ignored by any sane browser. IE6 doesn't know max-width
40 # so it uses _width instead
41 $this->mAttribs
['style'] = "max-width: {$maxwidth}px;_width: {$maxwidth}px;" .
45 $attribs = Sanitizer
::mergeAttributes(
46 array( 'class' => 'gallery mw-gallery-' . $this->mMode
), $this->mAttribs
);
48 $modules = $this->getModules();
50 if ( $this->mParser
) {
51 $this->mParser
->getOutput()->addModules( $modules );
53 $this->getOutput()->addModules( $modules );
55 $output = Xml
::openElement( 'ul', $attribs );
56 if ( $this->mCaption
) {
57 $output .= "\n\t<li class='gallerycaption'>{$this->mCaption}</li>";
60 $lang = $this->getRenderLang();
61 # Output each image...
62 foreach ( $this->mImages
as $pair ) {
64 $text = $pair[1]; # "text" means "caption" here
69 if ( $nt->getNamespace() === NS_FILE
) {
71 if ( $this->mParser
instanceof Parser
) {
72 # Give extensions a chance to select the file revision for us
74 wfRunHooks( 'BeforeParserFetchFileAndTitle',
75 array( $this->mParser
, $nt, &$options, &$descQuery ) );
76 # Fetch and register the file (file title may be different via hooks)
77 list( $img, $nt ) = $this->mParser
->fetchFileAndTitle( $nt, $options );
79 $img = wfFindFile( $nt );
85 $params = $this->getThumbParams( $img );
86 // $pair[4] is per image handler options
87 $transformOptions = $params +
$pair[4];
92 # We're dealing with a non-image, spit out the name and be done with it.
93 $thumbhtml = "\n\t\t\t" . '<div class="thumb" style="height: '
94 . ( $this->getThumbPadding() +
$this->mHeights
) . 'px;">'
95 . htmlspecialchars( $nt->getText() ) . '</div>';
97 if ( $this->mParser
instanceof Parser
) {
98 $this->mParser
->addTrackingCategory( 'broken-file-category' );
100 } elseif ( $this->mHideBadImages
101 && wfIsBadImage( $nt->getDBkey(), $this->getContextTitle() )
103 # The image is blacklisted, just show it as a text link.
104 $thumbhtml = "\n\t\t\t" . '<div class="thumb" style="height: ' .
105 ( $this->getThumbPadding() +
$this->mHeights
) . 'px;">' .
108 htmlspecialchars( $nt->getText() )
111 } elseif ( !( $thumb = $img->transform( $transformOptions ) ) ) {
112 # Error generating thumbnail.
113 $thumbhtml = "\n\t\t\t" . '<div class="thumb" style="height: '
114 . ( $this->getThumbPadding() +
$this->mHeights
) . 'px;">'
115 . htmlspecialchars( $img->getLastError() ) . '</div>';
117 $vpad = $this->getVPad( $this->mHeights
, $thumb->getHeight() );
119 $imageParameters = array(
121 'desc-query' => $descQuery,
123 'custom-url-link' => $link
126 // In the absence of both alt text and caption, fall back on
127 // providing screen readers with the filename as alt text
128 if ( $alt == '' && $text == '' ) {
129 $imageParameters['alt'] = $nt->getText();
132 $this->adjustImageParameters( $thumb, $imageParameters );
134 # Set both fixed width and min-height.
135 $thumbhtml = "\n\t\t\t"
136 . '<div class="thumb" style="width: '
137 . $this->getThumbDivWidth( $thumb->getWidth() ) . 'px;">'
138 # Auto-margin centering for block-level elements. Needed
139 # now that we have video handlers since they may emit block-
140 # level elements as opposed to simple <img> tags. ref
141 # http://css-discuss.incutio.com/?page=CenteringBlockElement
142 . '<div style="margin:' . $vpad . 'px auto;">'
143 . $thumb->toHtml( $imageParameters ) . '</div></div>';
145 // Call parser transform hook
146 if ( $this->mParser
&& $img->getHandler() ) {
147 $img->getHandler()->parserTransformHook( $this->mParser
, $img );
151 // @todo Code is incomplete.
152 // $linkTarget = Title::newFromText( $wgContLang->getNsText( MWNamespace::getUser() ) .
154 // $ul = Linker::link( $linkTarget, $ut );
156 if ( $this->mShowBytes
) {
158 $fileSize = htmlspecialchars( $lang->formatSize( $img->getSize() ) );
160 $fileSize = $this->msg( 'filemissing' )->escaped();
162 $fileSize = "$fileSize<br />\n";
167 $textlink = $this->mShowFilename ?
170 htmlspecialchars( $lang->truncate( $nt->getText(), $this->mCaptionLength
) )
174 $galleryText = $textlink . $text . $fileSize;
175 $galleryText = $this->wrapGalleryText( $galleryText, $thumb );
177 # Weird double wrapping (the extra div inside the li) needed due to FF2 bug
178 # Can be safely removed if FF2 falls completely out of existence
179 $output .= "\n\t\t" . '<li class="gallerybox" style="width: '
180 . $this->getGBWidth( $thumb ) . 'px">'
181 . '<div style="width: ' . $this->getGBWidth( $thumb ) . 'px">'
184 . "\n\t\t</div></li>";
186 $output .= "\n</ul>";
192 * Add the wrapper html around the thumb's caption
194 * @param string $galleryText The caption
195 * @param MediaTransformOutput|bool $thumb The thumb this caption is for
196 * or false for bad image.
199 protected function wrapGalleryText( $galleryText, $thumb ) {
200 # ATTENTION: The newline after <div class="gallerytext"> is needed to
201 # accommodate htmltidy which in version 4.8.6 generated crackpot html in
202 # its absence, see: http://bugzilla.wikimedia.org/show_bug.cgi?id=1765
205 return "\n\t\t\t" . '<div class="gallerytext">' . "\n"
211 * How much padding such the thumb have between image and inner div that
212 * that contains the border. This is both for verical and horizontal
213 * padding. (However, it is cut in half in the vertical direction).
216 protected function getThumbPadding() {
221 * @note GB stands for gallerybox (as in the <li class="gallerybox"> element)
225 protected function getGBPadding() {
230 * Get how much extra space the borders around the image takes up.
232 * For this mode, it is 2px borders on each side + 2px implied padding on
233 * each side from the stylesheet, giving us 2*2+2*2 = 8.
236 protected function getGBBorders() {
243 * @return int Number of pixels of whitespace surrounding the thumbnail.
245 protected function getAllPadding() {
246 return $this->getThumbPadding() +
$this->getGBPadding() +
$this->getGBBorders();
250 * Get vertical padding for a thumbnail
252 * Generally this is the total height minus how high the thumb is.
254 * @param int $boxHeight How high we want the box to be.
255 * @param int $thumbHeight How high the thumbnail is.
256 * @return int Vertical padding to add on each side.
258 protected function getVPad( $boxHeight, $thumbHeight ) {
259 return ( $this->getThumbPadding() +
$boxHeight - $thumbHeight ) / 2;
263 * Get the transform parameters for a thumbnail.
265 * @param File $img The file in question. May be false for invalid image
268 protected function getThumbParams( $img ) {
270 'width' => $this->mWidths
,
271 'height' => $this->mHeights
276 * Get the width of the inner div that contains the thumbnail in
277 * question. This is the div with the class of "thumb".
279 * @param int $thumbWidth The width of the thumbnail.
280 * @return int Width of inner thumb div.
282 protected function getThumbDivWidth( $thumbWidth ) {
283 return $this->mWidths +
$this->getThumbPadding();
287 * Width of gallerybox <li>.
289 * Generally is the width of the image, plus padding on image
290 * plus padding on gallerybox.
292 * @note Important: parameter will be false if no thumb used.
293 * @param MediaTransformOutput|bool $thumb MediaTransformObject object or false.
294 * @return int Width of gallerybox element
296 protected function getGBWidth( $thumb ) {
297 return $this->mWidths +
$this->getThumbPadding() +
$this->getGBPadding();
301 * Get a list of modules to include in the page.
303 * Primarily intended for subclasses.
305 * @return array Modules to include
307 protected function getModules() {
312 * Adjust the image parameters for a thumbnail.
314 * Used by a subclass to insert extra high resolution images.
315 * @param MediaTransformOutput $thumb The thumbnail
316 * @param array $imageParameters Array of options
318 protected function adjustImageParameters( $thumb, &$imageParameters ) {
323 * Backwards compatibility. This always uses traditional mode
324 * if called the old way, for extensions that may expect traditional
327 * @deprecated 1.22 Use ImageGalleryBase::factory instead.
329 class ImageGallery
extends TraditionalImageGallery
{
330 function __construct( $mode = 'traditional' ) {
331 wfDeprecated( __METHOD__
, '1.22' );
332 parent
::__construct( $mode );