MediaWiki REL1_32
PackedOverlayImageGallery Class Reference

Packed overlay image gallery. More...

Inheritance diagram for PackedOverlayImageGallery:
Collaboration diagram for PackedOverlayImageGallery:

Protected Member Functions

 wrapGalleryText ( $galleryText, $thumb)
 Add the wrapper html around the thumb's caption.
 
- Protected Member Functions inherited from PackedImageGallery
 adjustImageParameters ( $thumb, &$imageParameters)
 Adjust the image parameters for a thumbnail.
 
 getGBPadding ()
 
 getGBWidth ( $thumb)
 
 getModules ()
 Add javascript which auto-justifies the rows by manipulating the image sizes.
 
 getThumbDivWidth ( $thumbWidth)
 Get the width of the inner div that contains the thumbnail in question.
 
 getThumbPadding ()
 How much padding the thumb has between the image and the inner div that contains the border.
 
 getThumbParams ( $img)
 
 getVPad ( $boxHeight, $thumbHeight)
 Get vertical padding for a thumbnail.
 
- Protected Member Functions inherited from TraditionalImageGallery
 getAllPadding ()
 Get total padding.
 
 getCaptionHtml (Title $nt, Language $lang)
 
 getCaptionLength ()
 Length (in characters) to truncate filename to in caption when using "showfilename" (if int).
 
 getGBBorders ()
 Get how much extra space the borders around the image takes up.
 
 getGBWidthOverwrite ( $thumb)
 Allows overwriting the computed width of the gallerybox with a string, like '100'.
 
- Protected Member Functions inherited from ImageGalleryBase
 getRenderLang ()
 Determines the correct language to be used for this image gallery.
 

Additional Inherited Members

- Public Member Functions inherited from PackedImageGallery
 __construct ( $mode='traditional', IContextSource $context=null)
 Create a new image gallery object.
 
 setPerRow ( $num)
 Do not support per-row on packed.
 
- Public Member Functions inherited from TraditionalImageGallery
 toHTML ()
 Return a HTML representation of the image gallery.
 
- Public Member Functions inherited from ImageGalleryBase
 add ( $title, $html='', $alt='', $link='', $handlerOpts=[])
 Add an image to the gallery.
 
 count ()
 
 getContextTitle ()
 Get the contextual title, if applicable.
 
 getImages ()
 Returns the list of images this gallery contains.
 
 insert ( $title, $html='', $alt='', $link='', $handlerOpts=[])
 Add an image at the beginning of the gallery.
 
 isEmpty ()
 isEmpty() returns true if the gallery contains no images
 
 setAdditionalOptions ( $options)
 Allow setting additional options.
 
 setAttributes ( $attribs)
 Set arbitrary attributes to go on the HTML gallery output element.
 
 setCaption ( $caption)
 Set the caption (as plain text)
 
 setCaptionHtml ( $caption)
 Set the caption (as HTML)
 
 setContextTitle ( $title)
 Set the contextual title.
 
 setHeights ( $num)
 Set how high each image will be, in pixels.
 
 setHideBadImages ( $flag=true)
 Set bad image flag.
 
 setParser ( $parser)
 Register a parser object.
 
 setShowBytes ( $f)
 Enable/Disable showing of the file size of an image in the gallery.
 
 setShowDimensions ( $f)
 Enable/Disable showing of the dimensions of an image in the gallery.
 
 setShowFilename ( $f)
 Enable/Disable showing of the filename of an image in the gallery.
 
 setWidths ( $num)
 Set how wide each image will be, in pixels.
 
- Public Member Functions inherited from ContextSource
 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage().
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID.
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object.
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object.
 
 msg ( $key)
 Get a Message object with context set Parameters are the same as wfMessage()
 
 setContext (IContextSource $context)
 
- Static Public Member Functions inherited from ImageGalleryBase
static factory ( $mode=false, IContextSource $context=null)
 Get a new image gallery.
 
- Public Attributes inherited from PackedImageGallery
const SCALE_FACTOR = 1.5
 We artificially have 1.5 the resolution necessary so that we can scale it up by that much on the client side, without worrying about requesting a new image.
 
- Public Attributes inherited from ImageGalleryBase
Parser $mParser
 Registered parser object for output callbacks.
 
- Protected Attributes inherited from ImageGalleryBase
Title $contextTitle = false
 Contextual title, used when images are being screened against the bad image list.
 
array $mAttribs = []
 
bool string $mCaption = false
 Gallery caption.
 
bool int $mCaptionLength = true
 Length to truncate filename to in caption when using "showfilename".
 
bool $mHideBadImages
 Hide blacklisted images?
 
array $mImages
 Gallery images.
 
string $mMode
 Gallery mode.
 
bool $mShowBytes
 Whether to show the filesize in bytes in categories.
 
bool $mShowDimensions
 Whether to show the dimensions in categories.
 
bool $mShowFilename
 Whether to show the filename.
 

Detailed Description

Packed overlay image gallery.

All images adjusted to be same height and image caption being placed over top of image.

Definition at line 25 of file PackedOverlayImageGallery.php.

Member Function Documentation

◆ wrapGalleryText()

PackedOverlayImageGallery::wrapGalleryText (   $galleryText,
  $thumb 
)
protected

Add the wrapper html around the thumb's caption.

Parameters
string$galleryTextThe caption
MediaTransformOutput | bool$thumbThe thumb this caption is for or false for bad image.
Returns
string

Reimplemented from TraditionalImageGallery.

Definition at line 34 of file PackedOverlayImageGallery.php.

References PackedImageGallery\getGBPadding(), PackedImageGallery\getGBWidth(), and PackedImageGallery\getThumbPadding().


The documentation for this class was generated from the following file: