NolinesImageGallery Class Reference

Inheritance diagram for NolinesImageGallery:

Collaboration diagram for NolinesImageGallery:

Protected Member Functions
	getGBBorders ()
	Get how much extra space the borders around the image takes up.
	getThumbPadding ()
	How much padding the thumb has between the image and the inner div that contains the border.
	getVPad ( $boxHeight, $thumbHeight)
	Get vertical padding for a thumbnail.
Protected Member Functions inherited from TraditionalImageGallery
	adjustImageParameters ( $thumb, &$imageParameters)
	Adjust the image parameters for a thumbnail.
	getAllPadding ()
	Get total padding.
	getCaptionHtml (Title $nt, Language $lang)
	getCaptionLength ()
	Length (in characters) to truncate filename to in caption when using "showfilename" (if int).
	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.
	getThumbParams ( $img)
	Get the transform parameters 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
Public Member Functions inherited from TraditionalImageGallery
	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=[])
	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.
	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 ()
	getWikiPage ()
	Get the WikiPage object.
	msg ( $key,... $params)
	Get a Message object with context set Parameters are the same as wfMessage()
	setContext (IContextSource $context)
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.
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 24 of file NolinesImageGallery.php.

Member Function Documentation

getGBBorders()

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

Definition at line 29 of file NolinesImageGallery.php.

getThumbPadding()

NolinesImageGallery::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 25 of file NolinesImageGallery.php.

getVPad()

NolinesImageGallery::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 34 of file NolinesImageGallery.php.

---

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

• includes/gallery/NolinesImageGallery.php