Image gallery. More...

Inheritance diagram for ImageGalleryBase:

[legend]

Collaboration diagram for ImageGalleryBase:

[legend]

Public Member Functions
	__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...

	setShowDimensions ( $f)
	Enable/Disable showing of the dimensions 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 ( $key)
	Get a Message object with context set Parameters are the same as wfMessage() More...

	setContext (IContextSource $context)
	Set the IContextSource object. More...

Static Public Member Functions
static	factory ( $mode=false, IContextSource $context=null)
	Get a new image gallery. More...

Public Attributes
Parser	$mParser
	Registered parser object for output callbacks. More...

Protected Member Functions
	getRenderLang ()
	Determines the correct language to be used for this image gallery. More...

Protected Attributes
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	$mShowDimensions
	Whether to show the dimensions in categories. More...

bool	$mShowFilename
	Whether to show the filename. More...

Static Private Member Functions
static	loadModes ()

Static Private Attributes
static bool	$modeMapping = false

Detailed Description

Image gallery.

Add images to the gallery using add(), then render that list to HTML using toHTML().

Definition at line 30 of file ImageGalleryBase.php.

Constructor & Destructor Documentation

◆ __construct()

ImageGalleryBase::__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 in PackedImageGallery, and SlideshowImageGallery.

Definition at line 136 of file ImageGalleryBase.php.

References ContextSource\$context, ContextSource\getConfig(), and ContextSource\setContext().

Member Function Documentation

◆ add()

ImageGalleryBase::add	(	$title,
		$html = `''`,
		$alt = `''`,
		$link = `''`,
		$handlerOpts = `[]`
	)

Add an image to the gallery.

Parameters

Title	$title	Title object of the image that is added to the gallery
string	$html	Additional HTML text to be shown. The name and size of the image are always shown.
string	$alt	Alt text for the image
string	$link	Override image link (optional)
array	$handlerOpts	Array of options for image handler (aka page number)

Definition at line 249 of file ImageGalleryBase.php.

References $html, $link, $title, and wfDebug().

◆ count()

ImageGalleryBase::count ( )

Returns: int Number of images in the gallery

Definition at line 345 of file ImageGalleryBase.php.

◆ factory()

static ImageGalleryBase::factory	(		$mode = `false`,
		IContextSource	$context = `null`
	)

static

Get a new image gallery.

This is the method other callers should use to get a gallery.

Parameters

string \| bool	$mode	Mode to use. False to use the default
IContextSource \| null	$context

Returns: ImageGalleryBase

Exceptions

MWException

Definition at line 92 of file ImageGalleryBase.php.

References ContextSource\$context, $wgContLang, IContextSource\getConfig(), RequestContext\getMainAndWarn(), global, and loadModes().

Referenced by CategoryViewer\clearCategoryState(), SpecialUpload\getDupeWarning(), NewFilesPager\getStartBody(), and ImageQueryPage\outputResults().

◆ getContextTitle()

ImageGalleryBase::getContextTitle ( )

Get the contextual title, if applicable.

Returns: Title|bool Title or false

Definition at line 363 of file ImageGalleryBase.php.

Referenced by TraditionalImageGallery\toHTML().

◆ getImages()

ImageGalleryBase::getImages ( )

Returns the list of images this gallery contains.

Returns: array

Definition at line 280 of file ImageGalleryBase.php.

References $mImages.

◆ getRenderLang()

ImageGalleryBase::getRenderLang ( )

protected

Determines the correct language to be used for this image gallery.

Returns: Language

Definition at line 373 of file ImageGalleryBase.php.

References ContextSource\getLanguage().

Referenced by TraditionalImageGallery\toHTML().

◆ insert()

ImageGalleryBase::insert	(	$title,
		$html = `''`,
		$alt = `''`,
		$link = `''`,
		$handlerOpts = `[]`
	)

Add an image at the beginning of the gallery.

Parameters

Title	$title	Title object of the image that is added to the gallery
string	$html	Additional HTML text to be shown. The name and size of the image are always shown.
string	$alt	Alt text for the image
string	$link	Override image link (optional)
array	$handlerOpts	Array of options for image handler (aka page number)

Definition at line 268 of file ImageGalleryBase.php.

References $html, $link, and $title.

◆ isEmpty()

ImageGalleryBase::isEmpty ( )

isEmpty() returns true if the gallery contains no images

Returns: bool

Definition at line 288 of file ImageGalleryBase.php.

◆ loadModes()

static ImageGalleryBase::loadModes ( )

staticprivate

Definition at line 113 of file ImageGalleryBase.php.

References Hooks\run().

Referenced by factory().

◆ setAdditionalOptions()

ImageGalleryBase::setAdditionalOptions ( $options )

Allow setting additional options.

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

Parameters

array $options Attributes of gallery tag

Reimplemented in SlideshowImageGallery.

Definition at line 236 of file ImageGalleryBase.php.

◆ setAttributes()

ImageGalleryBase::setAttributes ( $attribs )

Set arbitrary attributes to go on the HTML gallery output element.

Should be suitable for a

.

Note – if taking from user input, you should probably run through Sanitizer::validateAttributes() first.

Parameters

array $attribs Array of HTML attribute pairs

Definition at line 331 of file ImageGalleryBase.php.

References $attribs.

◆ setCaption()

ImageGalleryBase::setCaption ( $caption )

Set the caption (as plain text)

Parameters

string $caption Caption

Definition at line 182 of file ImageGalleryBase.php.

◆ setCaptionHtml()

ImageGalleryBase::setCaptionHtml ( $caption )

Set the caption (as HTML)

Parameters

string $caption Caption

Definition at line 191 of file ImageGalleryBase.php.

◆ setContextTitle()

ImageGalleryBase::setContextTitle ( $title )

Set the contextual title.

Parameters

Title $title Contextual title

Definition at line 354 of file ImageGalleryBase.php.

References $title.

◆ setHeights()

ImageGalleryBase::setHeights ( $num )

Set how high each image will be, in pixels.

Parameters

int $num Integer > 0; invalid numbers will be ignored

Definition at line 223 of file ImageGalleryBase.php.

◆ setHideBadImages()

ImageGalleryBase::setHideBadImages ( $flag = true )

Set bad image flag.

Parameters

bool $flag

Definition at line 173 of file ImageGalleryBase.php.

◆ setParser()

ImageGalleryBase::setParser ( $parser )

Register a parser object.

If you do not set this and the output of this gallery ends up in parser cache, the javascript will break!

Note: This also triggers using the page's target language instead of the user language.

Parameters

Parser $parser

Definition at line 165 of file ImageGalleryBase.php.

References $parser.

◆ setPerRow()

ImageGalleryBase::setPerRow ( $num )

Set how many images will be displayed per row.

Parameters

int $num Integer >= 0; If perrow=0 the gallery layout will adapt to screensize invalid numbers will be rejected

Reimplemented in PackedImageGallery.

Definition at line 201 of file ImageGalleryBase.php.

◆ setShowBytes()

ImageGalleryBase::setShowBytes ( $f )

Enable/Disable showing of the file size of an image in the gallery.

Enabled by default.

Parameters

bool $f Set to false to disable

Definition at line 308 of file ImageGalleryBase.php.

◆ setShowDimensions()

ImageGalleryBase::setShowDimensions ( $f )

Enable/Disable showing of the dimensions of an image in the gallery.

Enabled by default.

Parameters

bool $f Set to false to disable

Definition at line 298 of file ImageGalleryBase.php.

◆ setShowFilename()

ImageGalleryBase::setShowFilename ( $f )

Enable/Disable showing of the filename of an image in the gallery.

Enabled by default.

Parameters

bool $f Set to false to disable

Definition at line 318 of file ImageGalleryBase.php.

◆ setWidths()

ImageGalleryBase::setWidths ( $num )

Set how wide each image will be, in pixels.

Parameters

int $num Integer > 0; invalid numbers will be ignored

Definition at line 212 of file ImageGalleryBase.php.

◆ toHTML()

ImageGalleryBase::toHTML ( )

abstract

Display an html representation of the gallery.

Returns: string The html

Reimplemented in TraditionalImageGallery.

Member Data Documentation

◆ $contextTitle

Title ImageGalleryBase::$contextTitle = false

protected

Contextual title, used when images are being screened against the bad image list.

Definition at line 75 of file ImageGalleryBase.php.

◆ $mAttribs

array ImageGalleryBase::$mAttribs = []

protected

Definition at line 78 of file ImageGalleryBase.php.

◆ $mCaption

bool string ImageGalleryBase::$mCaption = false

protected

Gallery caption.

Default: false

Definition at line 59 of file ImageGalleryBase.php.

◆ $mHideBadImages

bool ImageGalleryBase::$mHideBadImages

protected

Hide blacklisted images?

Definition at line 64 of file ImageGalleryBase.php.

◆ $mImages

array ImageGalleryBase::$mImages

protected

Gallery images.

Definition at line 34 of file ImageGalleryBase.php.

Referenced by getImages().

◆ $mMode

string ImageGalleryBase::$mMode

protected

Gallery mode.

Default: traditional

Definition at line 54 of file ImageGalleryBase.php.

◆ $modeMapping

bool ImageGalleryBase::$modeMapping = false

staticprivate

Definition at line 81 of file ImageGalleryBase.php.

◆ $mParser

Parser ImageGalleryBase::$mParser

Registered parser object for output callbacks.

Definition at line 69 of file ImageGalleryBase.php.

◆ $mShowBytes

bool ImageGalleryBase::$mShowBytes

protected

Whether to show the filesize in bytes in categories.

Definition at line 39 of file ImageGalleryBase.php.

◆ $mShowDimensions

bool ImageGalleryBase::$mShowDimensions

protected

Whether to show the dimensions in categories.

Definition at line 44 of file ImageGalleryBase.php.

◆ $mShowFilename

bool ImageGalleryBase::$mShowFilename

protected

Whether to show the filename.

Default: true

Definition at line 49 of file ImageGalleryBase.php.

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

includes/gallery/ImageGalleryBase.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ count()

◆ factory()

◆ getContextTitle()

◆ getImages()

◆ getRenderLang()

◆ insert()

◆ isEmpty()

◆ loadModes()

◆ setAdditionalOptions()

◆ setAttributes()

◆ setCaption()

◆ setCaptionHtml()

◆ setContextTitle()

◆ setHeights()

◆ setHideBadImages()

◆ setParser()

◆ setPerRow()

◆ setShowBytes()

◆ setShowDimensions()

◆ setShowFilename()

◆ setWidths()

◆ toHTML()

Member Data Documentation

◆ $contextTitle

◆ $mAttribs

◆ $mCaption

◆ $mHideBadImages

◆ $mImages

◆ $mMode

◆ $modeMapping

◆ $mParser

◆ $mShowBytes

◆ $mShowDimensions

◆ $mShowFilename