MediaWiki  REL1_31
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 
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  }
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  is_int( $this->getCaptionLength() ) ?
199  $lang->truncate( $nt->getText(), $this->getCaptionLength() ) :
200  $nt->getText()
201  ),
202  [
203  'class' => 'galleryfilename' .
204  ( $this->getCaptionLength() === true ? ' galleryfilename-truncate' : '' )
205  ]
206  ) . "\n" :
207  '';
208 
209  $galleryText = $textlink . $text . $meta;
210  $galleryText = $this->wrapGalleryText( $galleryText, $thumb );
211 
212  $gbWidth = $this->getGBWidth( $thumb ) . 'px';
213  if ( $this->getGBWidthOverwrite( $thumb ) ) {
214  $gbWidth = $this->getGBWidthOverwrite( $thumb );
215  }
216  # Weird double wrapping (the extra div inside the li) needed due to FF2 bug
217  # Can be safely removed if FF2 falls completely out of existence
218  $output .= "\n\t\t" . '<li class="gallerybox" style="width: '
219  . $gbWidth . '">'
220  . '<div style="width: ' . $gbWidth . '">'
221  . $thumbhtml
222  . $galleryText
223  . "\n\t\t</div></li>";
224  }
225  $output .= "\n</ul>";
226 
227  return $output;
228  }
229 
238  protected function wrapGalleryText( $galleryText, $thumb ) {
239  # ATTENTION: The newline after <div class="gallerytext"> is needed to
240  # accommodate htmltidy which in version 4.8.6 generated crackpot html in
241  # its absence, see: https://phabricator.wikimedia.org/T3765
242  # -Ævar
243 
244  return "\n\t\t\t" . '<div class="gallerytext">' . "\n"
245  . $galleryText
246  . "\n\t\t\t</div>";
247  }
248 
255  protected function getThumbPadding() {
256  return 30;
257  }
258 
264  protected function getGBPadding() {
265  return 5;
266  }
267 
275  protected function getGBBorders() {
276  return 8;
277  }
278 
286  protected function getCaptionLength() {
287  return $this->mCaptionLength;
288  }
289 
295  protected function getAllPadding() {
296  return $this->getThumbPadding() + $this->getGBPadding() + $this->getGBBorders();
297  }
298 
308  protected function getVPad( $boxHeight, $thumbHeight ) {
309  return ( $this->getThumbPadding() + $boxHeight - $thumbHeight ) / 2;
310  }
311 
318  protected function getThumbParams( $img ) {
319  return [
320  'width' => $this->mWidths,
321  'height' => $this->mHeights
322  ];
323  }
324 
332  protected function getThumbDivWidth( $thumbWidth ) {
333  return $this->mWidths + $this->getThumbPadding();
334  }
335 
346  protected function getGBWidth( $thumb ) {
347  return $this->mWidths + $this->getThumbPadding() + $this->getGBPadding();
348  }
349 
361  protected function getGBWidthOverwrite( $thumb ) {
362  return false;
363  }
364 
372  protected function getModules() {
373  return [];
374  }
375 
383  protected function adjustImageParameters( $thumb, &$imageParameters ) {
384  }
385 }
$handler
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:903
LinkBatch
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
TraditionalImageGallery\getThumbParams
getThumbParams( $img)
Get the transform parameters for a thumbnail.
Definition: TraditionalImageGallery.php:318
$output
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:2255
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
ImageGalleryBase
Image gallery.
Definition: ImageGalleryBase.php:30
ContextSource\msg
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
Definition: ContextSource.php:168
TraditionalImageGallery\toHTML
toHTML()
Return a HTML representation of the image gallery.
Definition: TraditionalImageGallery.php:35
Sanitizer\mergeAttributes
static mergeAttributes( $a, $b)
Merge two sets of HTML attributes.
Definition: Sanitizer.php:910
NS_FILE
const NS_FILE
Definition: Defines.php:80
$params
$params
Definition: styleTest.css.php:40
ImageGalleryBase\$mCaptionLength
bool int $mCaptionLength
Length to truncate filename to in caption when using "showfilename".
Definition: ImageGalleryBase.php:68
TraditionalImageGallery\getCaptionLength
getCaptionLength()
Length to truncate filename to in caption when using "showfilename" (if int).
Definition: TraditionalImageGallery.php:286
Linker\linkKnown
static linkKnown( $target, $html=null, $customAttribs=[], $query=[], $options=[ 'known'])
Identical to link(), except $options defaults to 'known'.
Definition: Linker.php:164
Linker\processResponsiveImages
static processResponsiveImages( $file, $thumb, $hp)
Process responsive images: add 1.5x and 2x subimages to the thumbnail, where applicable.
Definition: Linker.php:655
Xml\openElement
static openElement( $element, $attribs=null)
This opens an XML element.
Definition: Xml.php:109
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
means
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
TraditionalImageGallery\getGBWidthOverwrite
getGBWidthOverwrite( $thumb)
Allows overwriting the computed width of the gallerybox with a string, like '100'.
Definition: TraditionalImageGallery.php:361
TraditionalImageGallery\getGBBorders
getGBBorders()
Get how much extra space the borders around the image takes up.
Definition: TraditionalImageGallery.php:275
TraditionalImageGallery\getVPad
getVPad( $boxHeight, $thumbHeight)
Get vertical padding for a thumbnail.
Definition: TraditionalImageGallery.php:308
TraditionalImageGallery
Definition: TraditionalImageGallery.php:23
ContextSource\getOutput
getOutput()
Definition: ContextSource.php:112
$modules
$modules
Definition: HTMLFormElement.php:12
TraditionalImageGallery\wrapGalleryText
wrapGalleryText( $galleryText, $thumb)
Add the wrapper html around the thumb's caption.
Definition: TraditionalImageGallery.php:238
$link
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3021
TraditionalImageGallery\getModules
getModules()
Get a list of modules to include in the page.
Definition: TraditionalImageGallery.php:372
TraditionalImageGallery\getGBWidth
getGBWidth( $thumb)
Computed width of gallerybox .
Definition: TraditionalImageGallery.php:346
list
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
$options
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:2001
wfIsBadImage
wfIsBadImage( $name, $contextTitle=false, $blacklist=null)
Determine if an image exists on the 'bad image list'.
Definition: GlobalFunctions.php:3238
$attribs
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:2014
TraditionalImageGallery\adjustImageParameters
adjustImageParameters( $thumb, &$imageParameters)
Adjust the image parameters for a thumbnail.
Definition: TraditionalImageGallery.php:383
TraditionalImageGallery\getGBPadding
getGBPadding()
Definition: TraditionalImageGallery.php:264
TraditionalImageGallery\getAllPadding
getAllPadding()
Get total padding.
Definition: TraditionalImageGallery.php:295
Parser
PHP Parser - Processes wiki markup (which uses a more user-friendly syntax, such as "[[link]]" for ma...
Definition: Parser.php:70
wfFindFile
wfFindFile( $title, $options=[])
Find a file.
Definition: GlobalFunctions.php:2853
ImageGalleryBase\getRenderLang
getRenderLang()
Determines the correct language to be used for this image gallery.
Definition: ImageGalleryBase.php:386
TraditionalImageGallery\getThumbPadding
getThumbPadding()
How much padding the thumb has between the image and the inner div that contains the border.
Definition: TraditionalImageGallery.php:255
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
TraditionalImageGallery\getThumbDivWidth
getThumbDivWidth( $thumbWidth)
Get the width of the inner div that contains the thumbnail in question.
Definition: TraditionalImageGallery.php:332
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203