MediaWiki REL1_30
TraditionalImageGallery.php
Go to the documentation of this file.
1<?php
35 function toHTML() {
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;" .
42 $oldStyle;
43 }
44
45 $attribs = Sanitizer::mergeAttributes(
46 [ 'class' => 'gallery mw-gallery-' . $this->mMode ], $this->mAttribs );
47
48 $modules = $this->getModules();
49
50 if ( $this->mParser ) {
51 $this->mParser->getOutput()->addModules( $modules );
52 $this->mParser->getOutput()->addModuleStyles( 'mediawiki.page.gallery.styles' );
53 } else {
54 $this->getOutput()->addModules( $modules );
55 $this->getOutput()->addModuleStyles( 'mediawiki.page.gallery.styles' );
56 }
57 $output = Xml::openElement( 'ul', $attribs );
58 if ( $this->mCaption ) {
59 $output .= "\n\t<li class='gallerycaption'>{$this->mCaption}</li>";
60 }
61
62 if ( $this->mShowFilename ) {
63 // Preload LinkCache info for when generating links
64 // of the filename below
65 $lb = new LinkBatch();
66 foreach ( $this->mImages as $img ) {
67 $lb->addObj( $img[0] );
68 }
69 $lb->execute();
70 }
71
72 $lang = $this->getRenderLang();
73 # Output each image...
74 foreach ( $this->mImages as $pair ) {
76 $nt = $pair[0];
77 $text = $pair[1]; # "text" means "caption" here
78 $alt = $pair[2];
79 $link = $pair[3];
80
81 $descQuery = false;
82 if ( $nt->getNamespace() === NS_FILE ) {
83 # Get the file...
84 if ( $this->mParser instanceof Parser ) {
85 # Give extensions a chance to select the file revision for us
86 $options = [];
87 Hooks::run( 'BeforeParserFetchFileAndTitle',
88 [ $this->mParser, $nt, &$options, &$descQuery ] );
89 # Fetch and register the file (file title may be different via hooks)
90 list( $img, $nt ) = $this->mParser->fetchFileAndTitle( $nt, $options );
91 } else {
92 $img = wfFindFile( $nt );
93 }
94 } else {
95 $img = false;
96 }
97
98 $params = $this->getThumbParams( $img );
99 // $pair[4] is per image handler options
100 $transformOptions = $params + $pair[4];
101
102 $thumb = false;
103
104 if ( !$img ) {
105 # We're dealing with a non-image, spit out the name and be done with it.
106 $thumbhtml = "\n\t\t\t" . '<div class="thumb" style="height: '
107 . ( $this->getThumbPadding() + $this->mHeights ) . 'px;">'
108 . htmlspecialchars( $nt->getText() ) . '</div>';
109
110 if ( $this->mParser instanceof Parser ) {
111 $this->mParser->addTrackingCategory( 'broken-file-category' );
112 }
113 } elseif ( $this->mHideBadImages
114 && wfIsBadImage( $nt->getDBkey(), $this->getContextTitle() )
115 ) {
116 # The image is blacklisted, just show it as a text link.
117 $thumbhtml = "\n\t\t\t" . '<div class="thumb" style="height: ' .
118 ( $this->getThumbPadding() + $this->mHeights ) . 'px;">' .
120 $nt,
121 htmlspecialchars( $nt->getText() )
122 ) .
123 '</div>';
124 } else {
125 $thumb = $img->transform( $transformOptions );
126 if ( !$thumb ) {
127 # Error generating thumbnail.
128 $thumbhtml = "\n\t\t\t" . '<div class="thumb" style="height: '
129 . ( $this->getThumbPadding() + $this->mHeights ) . 'px;">'
130 . htmlspecialchars( $img->getLastError() ) . '</div>';
131 } else {
133 $vpad = $this->getVPad( $this->mHeights, $thumb->getHeight() );
134
135 $imageParameters = [
136 'desc-link' => true,
137 'desc-query' => $descQuery,
138 'alt' => $alt,
139 'custom-url-link' => $link
140 ];
141
142 // In the absence of both alt text and caption, fall back on
143 // providing screen readers with the filename as alt text
144 if ( $alt == '' && $text == '' ) {
145 $imageParameters['alt'] = $nt->getText();
146 }
147
148 $this->adjustImageParameters( $thumb, $imageParameters );
149
150 Linker::processResponsiveImages( $img, $thumb, $transformOptions );
151
152 # Set both fixed width and min-height.
153 $thumbhtml = "\n\t\t\t"
154 . '<div class="thumb" style="width: '
155 . $this->getThumbDivWidth( $thumb->getWidth() ) . 'px;">'
156 # Auto-margin centering for block-level elements. Needed
157 # now that we have video handlers since they may emit block-
158 # level elements as opposed to simple <img> tags. ref
159 # http://css-discuss.incutio.com/?page=CenteringBlockElement
160 . '<div style="margin:' . $vpad . 'px auto;">'
161 . $thumb->toHtml( $imageParameters ) . '</div></div>';
162
163 // Call parser transform hook
165 $handler = $img->getHandler();
166 if ( $this->mParser && $handler ) {
167 $handler->parserTransformHook( $this->mParser, $img );
168 }
169 }
170 }
171
172 // @todo Code is incomplete.
173 // $linkTarget = Title::newFromText( $wgContLang->getNsText( MWNamespace::getUser() ) .
174 // ":{$ut}" );
175 // $ul = Linker::link( $linkTarget, $ut );
176
177 $meta = [];
178 if ( $img ) {
179 if ( $this->mShowDimensions ) {
180 $meta[] = $img->getDimensionsString();
181 }
182 if ( $this->mShowBytes ) {
183 $meta[] = htmlspecialchars( $lang->formatSize( $img->getSize() ) );
184 }
185 } elseif ( $this->mShowDimensions || $this->mShowBytes ) {
186 $meta[] = $this->msg( 'filemissing' )->escaped();
187 }
188 $meta = $lang->semicolonList( $meta );
189 if ( $meta ) {
190 $meta .= "<br />\n";
191 }
192
193 $textlink = $this->mShowFilename ?
194 // Preloaded into LinkCache above
196 $nt,
197 htmlspecialchars(
198 $this->mCaptionLength !== true ?
199 $lang->truncate( $nt->getText(), $this->mCaptionLength ) :
200 $nt->getText()
201 ),
202 [
203 'class' => 'galleryfilename' .
204 ( $this->mCaptionLength === true ? ' galleryfilename-truncate' : '' )
205 ]
206 ) . "\n" :
207 '';
208
209 $galleryText = $textlink . $text . $meta;
210 $galleryText = $this->wrapGalleryText( $galleryText, $thumb );
211
212 # Weird double wrapping (the extra div inside the li) needed due to FF2 bug
213 # Can be safely removed if FF2 falls completely out of existence
214 $output .= "\n\t\t" . '<li class="gallerybox" style="width: '
215 . $this->getGBWidth( $thumb ) . 'px">'
216 . '<div style="width: ' . $this->getGBWidth( $thumb ) . 'px">'
217 . $thumbhtml
218 . $galleryText
219 . "\n\t\t</div></li>";
220 }
221 $output .= "\n</ul>";
222
223 return $output;
224 }
225
234 protected function wrapGalleryText( $galleryText, $thumb ) {
235 # ATTENTION: The newline after <div class="gallerytext"> is needed to
236 # accommodate htmltidy which in version 4.8.6 generated crackpot html in
237 # its absence, see: https://phabricator.wikimedia.org/T3765
238 # -Ævar
239
240 return "\n\t\t\t" . '<div class="gallerytext">' . "\n"
241 . $galleryText
242 . "\n\t\t\t</div>";
243 }
244
251 protected function getThumbPadding() {
252 return 30;
253 }
254
260 protected function getGBPadding() {
261 return 5;
262 }
263
271 protected function getGBBorders() {
272 return 8;
273 }
274
280 protected function getAllPadding() {
281 return $this->getThumbPadding() + $this->getGBPadding() + $this->getGBBorders();
282 }
283
293 protected function getVPad( $boxHeight, $thumbHeight ) {
294 return ( $this->getThumbPadding() + $boxHeight - $thumbHeight ) / 2;
295 }
296
303 protected function getThumbParams( $img ) {
304 return [
305 'width' => $this->mWidths,
306 'height' => $this->mHeights
307 ];
308 }
309
317 protected function getThumbDivWidth( $thumbWidth ) {
318 return $this->mWidths + $this->getThumbPadding();
319 }
320
331 protected function getGBWidth( $thumb ) {
332 return $this->mWidths + $this->getThumbPadding() + $this->getGBPadding();
333 }
334
342 protected function getModules() {
343 return [];
344 }
345
353 protected function adjustImageParameters( $thumb, &$imageParameters ) {
354 }
355}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control means(i) the power
wfFindFile( $title, $options=[])
Find a file.
wfIsBadImage( $name, $contextTitle=false, $blacklist=null)
Determine if an image exists on the 'bad image list'.
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
getOutput()
Get the OutputPage object.
getRenderLang()
Determines the correct language to be used for this image gallery.
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition LinkBatch.php:34
static linkKnown( $target, $html=null, $customAttribs=[], $query=[], $options=[ 'known'])
Identical to link(), except $options defaults to 'known'.
Definition Linker.php:164
static processResponsiveImages( $file, $thumb, $hp)
Process responsive images: add 1.5x and 2x subimages to the thumbnail, where applicable.
Definition Linker.php:655
PHP Parser - Processes wiki markup (which uses a more user-friendly syntax, such as "[[link]]" for ma...
Definition Parser.php:70
getThumbPadding()
How much padding the thumb has between the image and the inner div that contains the border.
getVPad( $boxHeight, $thumbHeight)
Get vertical padding for a thumbnail.
getThumbParams( $img)
Get the transform parameters for a thumbnail.
toHTML()
Return a HTML representation of the image gallery.
getGBWidth( $thumb)
Width of gallerybox .
getModules()
Get a list of modules to include in the page.
getGBBorders()
Get how much extra space the borders around the image takes up.
wrapGalleryText( $galleryText, $thumb)
Add the wrapper html around the thumb's caption.
adjustImageParameters( $thumb, &$imageParameters)
Adjust the image parameters for a thumbnail.
getThumbDivWidth( $thumbWidth)
Get the width of the inner div that contains the thumbnail in question.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition deferred.txt:11
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place $output
Definition hooks.txt:2225
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition hooks.txt:1971
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition hooks.txt:2989
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition hooks.txt:1984
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
Definition hooks.txt:901
const NS_FILE
Definition Defines.php:71
$params
if(!isset( $args[0])) $lang