MediaWiki  1.28.0
ImageGallery Class Reference

Backwards compatibility. More...

Inheritance diagram for ImageGallery:
Collaboration diagram for ImageGallery:

Public Member Functions

 __construct ($mode= 'traditional')
 
- Public Member Functions inherited from TraditionalImageGallery
 toHTML ()
 Return a HTML representation of the image gallery. More...
 
- Public Member Functions inherited from ImageGalleryBase
 __construct ($mode= 'traditional', IContextSource $context=null)
 Create a new image gallery object. More...
 
 add ($title, $html= '', $alt= '', $link= '', $handlerOpts=[])
 Add an image to the gallery. More...
 
 count ()
 
 getContextTitle ()
 Get the contextual title, if applicable. More...
 
 getImages ()
 Returns the list of images this gallery contains. More...
 
 insert ($title, $html= '', $alt= '', $link= '', $handlerOpts=[])
 Add an image at the beginning of the gallery. More...
 
 isEmpty ()
 isEmpty() returns true if the gallery contains no images More...
 
 setAdditionalOptions ($options)
 Allow setting additional options. More...
 
 setAttributes ($attribs)
 Set arbitrary attributes to go on the HTML gallery output element. More...
 
 setCaption ($caption)
 Set the caption (as plain text) More...
 
 setCaptionHtml ($caption)
 Set the caption (as HTML) More...
 
 setContextTitle ($title)
 Set the contextual title. More...
 
 setHeights ($num)
 Set how high each image will be, in pixels. More...
 
 setHideBadImages ($flag=true)
 Set bad image flag. More...
 
 setParser ($parser)
 Register a parser object. More...
 
 setPerRow ($num)
 Set how many images will be displayed per row. More...
 
 setShowBytes ($f)
 Enable/Disable showing of the file size of an image in the gallery. More...
 
 setShowFilename ($f)
 Enable/Disable showing of the filename of an image in the gallery. More...
 
 setWidths ($num)
 Set how wide each image will be, in pixels. More...
 
 toHTML ()
 Display an html representation of the gallery. More...
 
- Public Member Functions inherited from ContextSource
 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage(). More...
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID. More...
 
 getConfig ()
 Get the Config object. More...
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 Get the Language object. More...
 
 getOutput ()
 Get the OutputPage object. More...
 
 getRequest ()
 Get the WebRequest object. More...
 
 getSkin ()
 Get the Skin object. More...
 
 getStats ()
 Get the Stats object. More...
 
 getTiming ()
 Get the Timing object. More...
 
 getTitle ()
 Get the Title object. More...
 
 getUser ()
 Get the User object. More...
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ()
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 Set the IContextSource object. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ImageGalleryBase
static factory ($mode=false, IContextSource $context=null)
 Get a new image gallery. More...
 
- Public Attributes inherited from ImageGalleryBase
Parser $mParser
 Registered parser object for output callbacks. More...
 
- Protected Member Functions inherited from TraditionalImageGallery
 adjustImageParameters ($thumb, &$imageParameters)
 Adjust the image parameters for a thumbnail. More...
 
 getAllPadding ()
 Get total padding. More...
 
 getGBBorders ()
 Get how much extra space the borders around the image takes up. More...
 
 getGBPadding ()
 
 getGBWidth ($thumb)
 Width of gallerybox . More...
 
 getModules ()
 Get a list of modules to include in the page. More...
 
 getThumbDivWidth ($thumbWidth)
 Get the width of the inner div that contains the thumbnail in question. More...
 
 getThumbPadding ()
 How much padding the thumb has between the image and the inner div that contains the border. More...
 
 getThumbParams ($img)
 Get the transform parameters for a thumbnail. More...
 
 getVPad ($boxHeight, $thumbHeight)
 Get vertical padding for a thumbnail. More...
 
 wrapGalleryText ($galleryText, $thumb)
 Add the wrapper html around the thumb's caption. More...
 
- Protected Member Functions inherited from ImageGalleryBase
 getRenderLang ()
 Determines the correct language to be used for this image gallery. More...
 
- Protected Attributes inherited from ImageGalleryBase
Title $contextTitle = false
 Contextual title, used when images are being screened against the bad image list. More...
 
array $mAttribs = []
 
bool string $mCaption = false
 Gallery caption. More...
 
bool $mHideBadImages
 Hide blacklisted images? More...
 
array $mImages
 Gallery images. More...
 
string $mMode
 Gallery mode. More...
 
bool $mShowBytes
 Whether to show the filesize in bytes in categories. More...
 
bool $mShowFilename
 Whether to show the filename. More...
 

Detailed Description

Backwards compatibility.

This always uses traditional mode if called the old way, for extensions that may expect traditional mode.

Deprecated:
since 1.22 Use ImageGalleryBase::factory instead.

Definition at line 359 of file TraditionalImageGallery.php.

Constructor & Destructor Documentation

ImageGallery::__construct (   $mode = 'traditional')

Definition at line 360 of file TraditionalImageGallery.php.

References wfDeprecated().


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