Inheritance diagram for PackedImageGallery:

[legend]

Collaboration diagram for PackedImageGallery:

[legend]

Public Member Functions
	__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,... $params)
	Get a Message object with context set Parameters are the same as wfMessage()

	setContext (IContextSource $context)

Public Attributes
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 false	$mParser
	Registered parser object for output callbacks.

Protected Member Functions
	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'.

	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.

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.

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 23 of file PackedImageGallery.php.

Constructor & Destructor Documentation

◆ __construct()

PackedImageGallery::__construct	(		$mode = 'traditional',
		IContextSource	$context = null )

Create a new image gallery object.

You should not call this directly, but instead use ImageGalleryBase::factory().

Parameters

string	$mode
IContextSource \| null	$context

Reimplemented from ImageGalleryBase.

Definition at line 24 of file PackedImageGallery.php.

References ContextSource\$context.

Member Function Documentation

◆ adjustImageParameters()

PackedImageGallery::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 from TraditionalImageGallery.

Definition at line 89 of file PackedImageGallery.php.

◆ getGBPadding()

PackedImageGallery::getGBPadding ( )

protected

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

Returns: int

Reimplemented from TraditionalImageGallery.

Definition at line 45 of file PackedImageGallery.php.

Referenced by getGBWidth(), and PackedOverlayImageGallery\wrapGalleryText().

◆ getGBWidth()

PackedImageGallery::getGBWidth ( $thumb )

protected

Parameters

MediaTransformOutput | bool $thumb The thumbnail, or false if no thumb (which can happen)

Returns: float

Reimplemented from TraditionalImageGallery.

Definition at line 83 of file PackedImageGallery.php.

References getGBPadding(), getThumbDivWidth(), and SCALE_FACTOR.

Referenced by PackedOverlayImageGallery\wrapGalleryText().

◆ getModules()

PackedImageGallery::getModules ( )

protected

Add javascript which auto-justifies the rows by manipulating the image sizes.

Also ensures that the hover version of this degrades gracefully.

Returns: array

Reimplemented from TraditionalImageGallery.

Definition at line 100 of file PackedImageGallery.php.

◆ getThumbDivWidth()

PackedImageGallery::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 from TraditionalImageGallery.

Definition at line 69 of file PackedImageGallery.php.

References getThumbPadding(), and SCALE_FACTOR.

Referenced by getGBWidth().

◆ getThumbPadding()

PackedImageGallery::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 from TraditionalImageGallery.

Definition at line 41 of file PackedImageGallery.php.

Referenced by getThumbDivWidth(), getVPad(), and PackedOverlayImageGallery\wrapGalleryText().

◆ getThumbParams()

PackedImageGallery::getThumbParams ( $img )

protected

Parameters

File $img The file being transformed. May be false

Returns: array

Reimplemented from TraditionalImageGallery.

Definition at line 53 of file PackedImageGallery.php.

References ImageGalleryBase\$mWidths, MEDIATYPE_AUDIO, and SCALE_FACTOR.

◆ getVPad()

PackedImageGallery::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 from TraditionalImageGallery.

Definition at line 37 of file PackedImageGallery.php.

References getThumbPadding().

◆ setPerRow()

PackedImageGallery::setPerRow ( $num )

Do not support per-row on packed.

It really doesn't work since the images have varying widths.

Parameters

int $num

Reimplemented from ImageGalleryBase.

Definition at line 109 of file PackedImageGallery.php.

Member Data Documentation

◆ SCALE_FACTOR

const PackedImageGallery::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.

Definition at line 35 of file PackedImageGallery.php.

Referenced by getGBWidth(), getThumbDivWidth(), and getThumbParams().

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

includes/gallery/PackedImageGallery.php

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ adjustImageParameters()

◆ getGBPadding()

◆ getGBWidth()

◆ getModules()

◆ getThumbDivWidth()

◆ getThumbPadding()

◆ getThumbParams()

◆ getVPad()

◆ setPerRow()

Member Data Documentation

◆ SCALE_FACTOR