MediaWiki\Gallery\SlideshowImageGallery Class Reference

A slideshow gallery shows one image at a time with controls to move around. More...

Inherits MediaWiki\Gallery\TraditionalImageGallery.

Collaboration diagram for MediaWiki\Gallery\SlideshowImageGallery:

Public Member Functions
	__construct ( $mode='traditional', ?IContextSource $context=null)
	Create a new image gallery object.You should not call this directly, but instead use ImageGalleryBase::factory(). Stability: stable to call Note constructors of subclasses must have a compatible signature for use by the factory() method. Parameters string $mode IContextSource | null $context
	setAdditionalOptions ( $params)
	Allow setting additional options.This is meant to allow extensions to add additional parameters to <gallery> parser tag. Stability: stable to override Parameters array $options Attributes of gallery tag
Public Member Functions inherited from MediaWiki\Gallery\TraditionalImageGallery
	toHTML ()
	Return a HTML representation of the image gallery.
Public Member Functions inherited from MediaWiki\Gallery\ImageGalleryBase
	add ( $title, $html='', $alt='', $link='', $handlerOpts=[], $loading=self::LOADING_DEFAULT, ?array $imageOptions=null)
	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=[], $loading=self::LOADING_DEFAULT, ?array $imageOptions=null)
	Add an image at the beginning of the gallery.
	isEmpty ()
	isEmpty() returns true if the gallery contains no images
	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)
	setParser ( $parser)
	Register a parser object.
	setPerRow ( $num)
	Set how many images will be displayed per row.
	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 MediaWiki\Context\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.
	getActionName ()
	Get the action name for the current web request.
	getAuthority ()
	getConfig ()
	getContext ()
	Get the base IContextSource object.
	getCsrfTokenSet ()
	Get a repository to obtain and match CSRF tokens.
	getLanguage ()
	getLanguageCode ()
	getOutput ()
	getRequest ()
	getSkin ()
	getTiming ()
	getTitle ()
	getUser ()
	getWikiPage ()
	Get the WikiPage object.
	msg ( $key,... $params)
	Get a Message object with context set Parameters are the same as wfMessage()
	setContext (IContextSource $context)

Protected Member Functions
	getModules ()
	Add javascript adds interface elements.
Protected Member Functions inherited from MediaWiki\Gallery\TraditionalImageGallery
	adjustImageParameters ( $thumb, &$imageParameters)
	Adjust the image parameters for a thumbnail.
	getAllPadding ()
	Get total padding.
	getCaptionHtml (Title $nt, Language $lang, LinkRenderer $linkRenderer)
	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.
	getGBPadding ()
	getGBWidth ( $thumb)
	Computed width of gallerybox .
	getGBWidthOverwrite ( $thumb)
	Allows overwriting the computed width of the gallerybox with a string, like '100'.
	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)
	Get the transform parameters for a thumbnail.
	getVPad ( $boxHeight, $thumbHeight)
	Get vertical padding for a thumbnail.
	wrapGalleryText ( $galleryText, $thumb)
	Add the wrapper html around the thumb's caption.
Protected Member Functions inherited from MediaWiki\Gallery\ImageGalleryBase
	getRenderLang ()
	Determines the correct language to be used for this image gallery.

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\Gallery\ImageGalleryBase
static	factory ( $mode=false, ?IContextSource $context=null)
	Get a new image gallery.
Public Attributes inherited from MediaWiki\Gallery\ImageGalleryBase
Parser false	$mParser
	Registered parser object for output callbacks.
const	LOADING_DEFAULT = 1
const	LOADING_LAZY = 2
Protected Attributes inherited from MediaWiki\Gallery\ImageGalleryBase
Title null	$contextTitle = null
	Contextual title, used when images are being screened against the bad image list.
array	$mAttribs = []
string false	$mCaption = false
	Gallery caption.
bool int	$mCaptionLength = true
	Length to truncate filename to in caption when using "showfilename".
int	$mHeights
bool	$mHideBadImages
	Hide bad images?
array[]	$mImages
	Gallery images.
string	$mMode
	Gallery mode.
int	$mPerRow
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.
int	$mWidths

Detailed Description

A slideshow gallery shows one image at a time with controls to move around.

Definition at line 14 of file SlideshowImageGallery.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Gallery\SlideshowImageGallery::__construct	(		$mode = 'traditional',
		?IContextSource	$context = null )

Create a new image gallery object.You should not call this directly, but instead use ImageGalleryBase::factory().

Stability: stable

to call

Note

constructors of subclasses must have a compatible signature for use by the factory() method.

Parameters

string	$mode
IContextSource | null	$context

Reimplemented from MediaWiki\Gallery\ImageGalleryBase.

Definition at line 16 of file SlideshowImageGallery.php.

Member Function Documentation

getModules()

MediaWiki\Gallery\SlideshowImageGallery::getModules ( )

protected

Add javascript adds interface elements.

Returns

array

Reimplemented from MediaWiki\Gallery\TraditionalImageGallery.

Definition at line 26 of file SlideshowImageGallery.php.

setAdditionalOptions()

MediaWiki\Gallery\SlideshowImageGallery::setAdditionalOptions

(

$params

)

Allow setting additional options.This is meant to allow extensions to add additional parameters to <gallery> parser tag.

Stability: stable

to override

Parameters

array

$options

Attributes of gallery tag

Reimplemented from MediaWiki\Gallery\ImageGalleryBase.

Definition at line 31 of file SlideshowImageGallery.php.

---

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

• includes/Gallery/SlideshowImageGallery.php