Inheritance diagram for TraditionalImageGallery:

[legend]

Collaboration diagram for TraditionalImageGallery:

[legend]

Public Member Functions
	toHTML ()
	Return a HTML representation of the image gallery.

Public Member Functions inherited from ImageGalleryBase
	__construct ( $mode='traditional', IContextSource $context=null)
	Create a new image gallery object.

	add ( $title, $html='', $alt='', $link='', $handlerOpts=[], $loading=self::LOADING_DEFAULT)
	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)
	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.

	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 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 ()
	Stable to override.

	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
	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'.

	getModules ()
	Get a list of modules to include in the page.

	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 ImageGalleryBase
	getRenderLang ()
	Determines the correct language to be used for this image gallery.

Additional Inherited Members
Static Public Member Functions inherited from ImageGalleryBase
static	factory ( $mode=false, IContextSource $context=null)
	Get a new image gallery.

Public Attributes inherited from ImageGalleryBase
Parser false	$mParser
	Registered parser object for output callbacks.

const	LOADING_DEFAULT = 1

const	LOADING_LAZY = 2

Protected Attributes inherited from ImageGalleryBase
Title null	$contextTitle = null
	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".

int	$mHeights

bool	$mHideBadImages
	Hide blacklisted images?

array[]	$mImages
	Gallery images -var array<int,array{0:Title,1:string,2:string,3:string,4:array,5:int}>

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

Definition at line 27 of file TraditionalImageGallery.php.

Member Function Documentation

◆ adjustImageParameters()

TraditionalImageGallery::adjustImageParameters	(		$thumb,
		&	$imageParameters
	)

protected

Adjust the image parameters for a thumbnail.

Used by a subclass to insert extra high resolution images.

Parameters

MediaTransformOutput	$thumb	The thumbnail
array	&$imageParameters	Array of options

Reimplemented in PackedImageGallery.

Definition at line 393 of file TraditionalImageGallery.php.

Referenced by toHTML().

◆ getAllPadding()

TraditionalImageGallery::getAllPadding ( )

protected

Get total padding.

Returns: int Number of pixels of whitespace surrounding the thumbnail.

Definition at line 305 of file TraditionalImageGallery.php.

References getGBBorders(), getGBPadding(), and getThumbPadding().

Referenced by toHTML().

◆ getCaptionHtml()

TraditionalImageGallery::getCaptionHtml	(	Title	$nt,
		Language	$lang,
		LinkRenderer	$linkRenderer
	)

protected

Parameters

Title	$nt
Language	$lang
LinkRenderer	$linkRenderer

Returns: string HTML

Definition at line 226 of file TraditionalImageGallery.php.

References getCaptionLength(), Title\getText(), MediaWiki\Linker\LinkRenderer\makeKnownLink(), and Language\truncateForVisual().

Referenced by toHTML().

◆ getCaptionLength()

TraditionalImageGallery::getCaptionLength ( )

protected

Length (in characters) to truncate filename to in caption when using "showfilename" (if int).

A value of 'true' will truncate the filename to one line using CSS, while 'false' will disable truncating.

Returns: int|bool

Definition at line 296 of file TraditionalImageGallery.php.

References ImageGalleryBase\$mCaptionLength.

Referenced by getCaptionHtml().

◆ getGBBorders()

TraditionalImageGallery::getGBBorders ( )

protected

Get how much extra space the borders around the image takes up.

For this mode, it is 2px borders on each side + 2px implied padding on each side from the stylesheet, giving us 2*2+2*2 = 8.

Returns: int

Reimplemented in NolinesImageGallery.

Definition at line 285 of file TraditionalImageGallery.php.

Referenced by getAllPadding().

◆ getGBPadding()

TraditionalImageGallery::getGBPadding ( )

protected

Note: GB stands for gallerybox (as in the element)

Returns: int

Reimplemented in PackedImageGallery.

Definition at line 274 of file TraditionalImageGallery.php.

Referenced by getAllPadding(), and getGBWidth().

◆ getGBWidth()

TraditionalImageGallery::getGBWidth ( $thumb )

protected

Computed width of gallerybox .

Generally is the width of the image, plus padding on image plus padding on gallerybox.

Note: Important: parameter will be false if no thumb used.

Parameters

MediaTransformOutput | bool $thumb MediaTransformObject object or false.

Returns: int Width of gallerybox element

Reimplemented in PackedImageGallery.

Definition at line 356 of file TraditionalImageGallery.php.

References getGBPadding(), and getThumbPadding().

Referenced by toHTML().

◆ getGBWidthOverwrite()

TraditionalImageGallery::getGBWidthOverwrite ( $thumb )

protected

Allows overwriting the computed width of the gallerybox with a string, like '100'.

Generally is the width of the image, plus padding on image plus padding on gallerybox.

Note: Important: parameter will be false if no thumb used.

Parameters

MediaTransformOutput | bool $thumb MediaTransformObject object or false.

Returns: bool|string Ignored if false.

Definition at line 371 of file TraditionalImageGallery.php.

Referenced by toHTML().

◆ getModules()

TraditionalImageGallery::getModules ( )

protected

Get a list of modules to include in the page.

Primarily intended for subclasses.

Returns: array Modules to include

Reimplemented in PackedImageGallery, and SlideshowImageGallery.

Definition at line 382 of file TraditionalImageGallery.php.

Referenced by toHTML().

◆ getThumbDivWidth()

TraditionalImageGallery::getThumbDivWidth ( $thumbWidth )

protected

Get the width of the inner div that contains the thumbnail in question.

This is the div with the class of "thumb".

Parameters

int $thumbWidth The width of the thumbnail.

Returns: int Width of inner thumb div.

Reimplemented in PackedImageGallery.

Definition at line 342 of file TraditionalImageGallery.php.

References getThumbPadding().

Referenced by toHTML().

◆ getThumbPadding()

TraditionalImageGallery::getThumbPadding ( )

protected

How much padding the thumb has between the image and the inner div that contains the border.

This is for both vertical and horizontal padding. (However, it is cut in half in the vertical direction).

Returns: int

Reimplemented in NolinesImageGallery, and PackedImageGallery.

Definition at line 265 of file TraditionalImageGallery.php.

Referenced by getAllPadding(), getGBWidth(), getThumbDivWidth(), getVPad(), and toHTML().

◆ getThumbParams()

TraditionalImageGallery::getThumbParams ( $img )

protected

Get the transform parameters for a thumbnail.

Parameters

File $img The file in question. May be false for invalid image

Returns: array

Reimplemented in PackedImageGallery.

Definition at line 328 of file TraditionalImageGallery.php.

References ImageGalleryBase\$mHeights, and ImageGalleryBase\$mWidths.

Referenced by toHTML().

◆ getVPad()

TraditionalImageGallery::getVPad	(	$boxHeight,
		$thumbHeight
	)

protected

Get vertical padding for a thumbnail.

Generally this is the total height minus how high the thumb is.

Parameters

int	$boxHeight	How high we want the box to be.
int	$thumbHeight	How high the thumbnail is.

Returns: int Vertical padding to add on each side.

Reimplemented in NolinesImageGallery, and PackedImageGallery.

Definition at line 318 of file TraditionalImageGallery.php.

References getThumbPadding().

Referenced by toHTML().

◆ toHTML()

TraditionalImageGallery::toHTML ( )

Return a HTML representation of the image gallery.

For each image in the gallery, display

a thumbnail
the image name
the additional text provided when adding the image
the size of the image

Returns: string

Reimplemented from ImageGalleryBase.

Definition at line 39 of file TraditionalImageGallery.php.

References $lang, ImageGalleryBase\$mHeights, adjustImageParameters(), getAllPadding(), getCaptionHtml(), getGBWidth(), getGBWidthOverwrite(), getModules(), ContextSource\getOutput(), Parser\getOutput(), ImageGalleryBase\getRenderLang(), getThumbDivWidth(), getThumbPadding(), getThumbParams(), getVPad(), ImageGalleryBase\LOADING_LAZY, ContextSource\msg(), NS_FILE, Linker\processResponsiveImages(), MediaTransformOutput\toHtml(), and wrapGalleryText().

◆ wrapGalleryText()

TraditionalImageGallery::wrapGalleryText	(	$galleryText,
		$thumb
	)

protected

Add the wrapper html around the thumb's caption.

Parameters

string	$galleryText	The caption
MediaTransformOutput \| bool	$thumb	The thumb this caption is for or false for bad image.

Returns: string

Reimplemented in PackedOverlayImageGallery.

Definition at line 248 of file TraditionalImageGallery.php.

Referenced by toHTML().

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

includes/gallery/TraditionalImageGallery.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ adjustImageParameters()

◆ getAllPadding()

◆ getCaptionHtml()

◆ getCaptionLength()

◆ getGBBorders()

◆ getGBPadding()

◆ getGBWidth()

◆ getGBWidthOverwrite()

◆ getModules()

◆ getThumbDivWidth()

◆ getThumbPadding()

◆ getThumbParams()

◆ getVPad()

◆ toHTML()

◆ wrapGalleryText()