Image gallery. More...

Inheritance diagram for ImageGalleryBase:

[legend]

Collaboration diagram for ImageGalleryBase:

[legend]

Public Member Functions
	__construct ( $mode='traditional')
	Create a new image gallery object. More...

	add ( $title, $html='', $alt='', $link='', $handlerOpts=array())
	Add an image to the gallery. More...

	count ()

	getContextTitle ()
	Get the contextual title, if applicable. More...

	insert ( $title, $html='', $alt='', $link='', $handlerOpts=array())
	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...

	useSkin ( $skin)
	Instruct the class to use a specific skin for rendering. 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 RequestContext object. More...

	getLang ()
	Get the Language 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...

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

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

Public Attributes
bool string	$mCaption = false
	Gallery caption. More...

bool	$mHideBadImages
	Hide blacklisted images? More...

array	$mImages
	Gallery images *. More...

string	$mMode
	Gallery mode. More...

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

bool	$mShowBytes
	Whether to show the filesize in bytes in categories *. More...

bool	$mShowFilename
	Whether to show the filename. 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 = array()

Static Private Member Functions
static	loadModes ()

Static Private Attributes
static	$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' )

Create a new image gallery object.

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

Reimplemented in ImageGallery, and PackedImageGallery.

Definition at line 102 of file ImageGalleryBase.php.

References array(), and global.

Member Function Documentation

◆ add()

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

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 220 of file ImageGalleryBase.php.

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

◆ count()

ImageGalleryBase::count ( )

Returns: int Number of images in the gallery

Definition at line 298 of file ImageGalleryBase.php.

◆ factory()

static ImageGalleryBase::factory ( $mode = false )

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.

Exceptions

MWException

Definition at line 66 of file ImageGalleryBase.php.

References $wgContLang, 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 316 of file ImageGalleryBase.php.

Referenced by TraditionalImageGallery\toHTML().

◆ getRenderLang()

ImageGalleryBase::getRenderLang ( )

protected

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

Returns: Language

Definition at line 326 of file ImageGalleryBase.php.

References ContextSource\getLanguage().

Referenced by TraditionalImageGallery\toHTML().

◆ insert()

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

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 239 of file ImageGalleryBase.php.

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

◆ isEmpty()

ImageGalleryBase::isEmpty ( )

isEmpty() returns true if the gallery contains no images

Returns: bool

Definition at line 251 of file ImageGalleryBase.php.

◆ loadModes()

static ImageGalleryBase::loadModes ( )

staticprivate

Definition at line 82 of file ImageGalleryBase.php.

References array(), and wfRunHooks().

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.

Definition at line 196 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 284 of file ImageGalleryBase.php.

References $attribs.

◆ setCaption()

ImageGalleryBase::setCaption ( $caption )

Set the caption (as plain text)

Parameters

string $caption Caption

Definition at line 142 of file ImageGalleryBase.php.

◆ setCaptionHtml()

ImageGalleryBase::setCaptionHtml ( $caption )

Set the caption (as HTML)

Parameters

string $caption Caption

Definition at line 151 of file ImageGalleryBase.php.

◆ setContextTitle()

ImageGalleryBase::setContextTitle ( $title )

Set the contextual title.

Parameters

Title $title Contextual title

Definition at line 307 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 183 of file ImageGalleryBase.php.

◆ setHideBadImages()

ImageGalleryBase::setHideBadImages ( $flag = true )

Set bad image flag.

Definition at line 133 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 126 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 161 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 261 of file ImageGalleryBase.php.

References $f.

◆ 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 271 of file ImageGalleryBase.php.

References $f.

◆ 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 172 of file ImageGalleryBase.php.

◆ toHTML()

ImageGalleryBase::toHTML ( )

abstract

Display an html representation of the gallery.

Returns: string The html

Reimplemented in TraditionalImageGallery.

◆ useSkin()

ImageGalleryBase::useSkin ( $skin )

Instruct the class to use a specific skin for rendering.

Parameters

Skin $skin

Deprecated:: since 1.18 Not used anymore

Definition at line 205 of file ImageGalleryBase.php.

References wfDeprecated().

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 52 of file ImageGalleryBase.php.

◆ $mAttribs

array ImageGalleryBase::$mAttribs = array()

protected

Definition at line 54 of file ImageGalleryBase.php.

◆ $mCaption

bool string ImageGalleryBase::$mCaption = false

Gallery caption.

Default: false *

Definition at line 39 of file ImageGalleryBase.php.

◆ $mHideBadImages

bool ImageGalleryBase::$mHideBadImages

Hide blacklisted images?

Definition at line 43 of file ImageGalleryBase.php.

◆ $mImages

array ImageGalleryBase::$mImages

Gallery images *.

Definition at line 31 of file ImageGalleryBase.php.

◆ $mMode

string ImageGalleryBase::$mMode

Gallery mode.

Default: traditional *

Definition at line 37 of file ImageGalleryBase.php.

◆ $modeMapping

ImageGalleryBase::$modeMapping = false

staticprivate

Definition at line 57 of file ImageGalleryBase.php.

◆ $mParser

Parser ImageGalleryBase::$mParser

Registered parser object for output callbacks.

Definition at line 47 of file ImageGalleryBase.php.

◆ $mShowBytes

bool ImageGalleryBase::$mShowBytes

Whether to show the filesize in bytes in categories *.

Definition at line 33 of file ImageGalleryBase.php.

◆ $mShowFilename

bool ImageGalleryBase::$mShowFilename

Whether to show the filename.

Default: true *

Definition at line 35 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()

◆ getRenderLang()

◆ insert()

◆ isEmpty()

◆ loadModes()

◆ setAdditionalOptions()

◆ setAttributes()

◆ setCaption()

◆ setCaptionHtml()

◆ setContextTitle()

◆ setHeights()

◆ setHideBadImages()

◆ setParser()

◆ setPerRow()

◆ setShowBytes()

◆ setShowFilename()

◆ setWidths()

◆ toHTML()

◆ useSkin()

Member Data Documentation

◆ $contextTitle

◆ $mAttribs

◆ $mCaption

◆ $mHideBadImages

◆ $mImages

◆ $mMode

◆ $modeMapping

◆ $mParser

◆ $mShowBytes

◆ $mShowFilename