Rendering of file description pages. More...

Collaboration diagram for ImagePage:

[legend]

Public Member Functions
	getDisplayedFile ()

	getDuplicates ()

	getFile ()

	getForeignCategories ()

	getUploadUrl ()

	isLocal ()

	setFile ( $file)

	showError ( $description)
	Display an error with a wikitext description.

	view ()
	This is the default action of the index.php entry point: just view the page of the given title.

Public Member Functions inherited from Article
	__construct (Title $title, $oldId=null)

	__get ( $fname)

	__set ( $fname, $fvalue)

	addHelpLink ( $to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators.

	adjustDisplayTitle (ParserOutput $pOutput)
	Adjust title for pages with displaytitle, -{T\|}- or language conversion.

	clear ()

	fetchRevisionRecord ()
	Fetches the revision to work on.

	getActionOverrides ()
	Call to WikiPage function for backwards compatibility.

	getContext ()
	Gets the context this Article is executed in.

	getOldID ()

	getOldIDFromRequest ()
	Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect.

	getPage ()
	Get the WikiPage object of this instance.

	getParserOptions ()
	Get parser options suitable for rendering the primary article wikitext.

	getParserOutput ( $oldid=null, UserIdentity $user=null)
	#-

	getRedirectedFrom ()
	Get the page this view was redirected from.

	getRevIdFetched ()
	Use this to fetch the rev ID used on page views.

	getRobotPolicy ( $action, ParserOutput $pOutput=null)
	Get the robot policy to be used for the current view.

	getTitle ()
	Get the title object of the article.

	isCurrent ()
	Returns true if the currently-referenced revision is the current edit to this page (and it exists).

	isFileCacheable ( $mode=HTMLFileCache::MODE_NORMAL)
	Check if the page can be cached.

	protect ()
	action=protect handler

	render ()
	Handle action=render.

	setContext ( $context)
	Sets the context this Article is executed in.

	setOldSubtitle ( $oldid=0)
	Generate the navigation links when browsing through an article revisions It shows the information as: Revision as of \<date\>; view current revision \<- Previous version \| Next Version -\>

	setRedirectedFrom (Title $from)
	Tell the page view functions that this view was redirected from another page on the wiki.

	showDeletedRevisionHeader ()
	If the revision requested for view is deleted, check permissions.

	showMissingArticle ()
	Show the error text for a missing article.

	showNamespaceHeader ()
	Show a header specific to the namespace currently being viewed, like [[MediaWiki:Talkpagetext]].

	showPatrolFooter ()
	If patrol is possible, output a patrol UI box.

	showRedirectedFromHeader ()
	If this request is a redirect view, send "redirected from" subtitle to the output.

	showViewFooter ()
	Show the footer section of an ordinary page view.

	unprotect ()
	action=unprotect handler (alias)

Protected Member Functions
	closeShowImage ()
	For overloading.

	compare ( $a, $b)
	Callback for usort() to do link sorts by (namespace, title) Function copied from Title::compare()

	doRenderLangOpt (array $langChoices, $renderLang)
	Output a drop-down box for language options for the file.

	getThumbPrevText ( $params, $sizeLinkBigImagePreview)
	Make the text under the image to say what size preview.

	getThumbSizes ( $origWidth, $origHeight)
	Get alternative thumbnail sizes.

	imageDupes ()

	imageHistory ()
	If the page we've just displayed is in the "Image" namespace, we follow it with an upload history of the image and its usage.

	imageLinks ()

	loadFile ()

	makeMetadataTable ( $metadata)
	Make a table with metadata to be shown in the output page.

	makeSizeLink ( $params, $width, $height)
	Creates a thumbnail of specified size and returns an HTML link to it.

	newPage (Title $title)

	openShowImage ()

	printSharedImageText ()
	Show a notice that the file is from a shared repository.

	queryImageLinks ( $target, $limit)

	showTOC ( $metadata)
	Create the TOC.

	uploadLinksBox ()
	Add the re-upload link (or message about not being able to re-upload) to the output.

Protected Member Functions inherited from Article
	isDiffOnlyView ()

	showDiffPage ()
	Show a diff page according to current request variables.

	tryFileCache ()
	checkLastModified returns true if it has taken care of all output to the client that is necessary for this request.

Protected Attributes
string false	$mExtraDescription = false
	Guaranteed to be HTML, {.

Protected Attributes inherited from Article
LinkRenderer	$linkRenderer

IContextSource null	$mContext
	The context this Article is executed in.

WikiPage	$mPage
	The WikiPage object of this instance.

bool	$viewIsRenderAction = false
	Whether render() was called.

Additional Inherited Members
Static Public Member Functions inherited from Article
static	formatRobotPolicy ( $policy)
	Converts a String robot policy into an associative array, to allow merging of several policies using array_merge().

static	getRedirectHeaderHtml (Language $lang, Title $target, $forceKnown=false)
	Return the HTML for the top of a redirect page.

static	newFromID ( $id)
	Constructor from a page id.

static	newFromTitle ( $title, IContextSource $context)
	Create an Article object of the appropriate class for the given page.

static	newFromWikiPage (WikiPage $page, IContextSource $context)
	Create an Article object of the appropriate class for the given page.

static	purgePatrolFooterCache ( $articleID)
	Purge the cache used to check if it is worth showing the patrol footer For example, it is done during re-uploads when file patrol is used.

Public Attributes inherited from Article
int null	$mOldId
	The oldid of the article that was requested to be shown, 0 for the current revision.

ParserOutput null false	$mParserOutput = null
	The ParserOutput generated for viewing the page, initialized by view().

Title null	$mRedirectedFrom = null
	Title from which we were redirected here, if any.

string false	$mRedirectUrl = false
	URL to redirect to or false if none.

Detailed Description

Rendering of file description pages.

@method WikiFilePage getPage()

Definition at line 37 of file ImagePage.php.

Member Function Documentation

◆ closeShowImage()

ImagePage::closeShowImage ( )

protected

For overloading.

Definition at line 838 of file ImagePage.php.

Referenced by view().

◆ compare()

ImagePage::compare	(		$a,
			$b )

protected

Callback for usort() to do link sorts by (namespace, title) Function copied from Title::compare()

Parameters

stdClass	$a	Object page to compare with
stdClass	$b	Object page to compare with

Returns: int Result of string comparison, or namespace comparison

Definition at line 1067 of file ImagePage.php.

◆ doRenderLangOpt()

ImagePage::doRenderLangOpt	(	array	$langChoices,
			$renderLang )

protected

Output a drop-down box for language options for the file.

Parameters

array	$langChoices	Array of string language codes
string \| null	$renderLang	Language code for the language we want the file to rendered in, it is pre-selected in the drop down box, use null to select the default case in the option list

Returns: string HTML to insert underneath image.

Definition at line 1080 of file ImagePage.php.

References getContext(), and getTitle().

Referenced by openShowImage().

◆ getDisplayedFile()

ImagePage::getDisplayedFile ( )

Returns: File

Definition at line 232 of file ImagePage.php.

References loadFile().

Referenced by ImageHistoryList\__construct().

◆ getDuplicates()

ImagePage::getDuplicates ( )

See also: WikiFilePage::getDuplicates

Returns: File[]|null

Definition at line 1201 of file ImagePage.php.

◆ getFile()

ImagePage::getFile ( )

See also: WikiFilePage::getFile

Returns: File

Definition at line 1185 of file ImagePage.php.

References Article\getPage().

◆ getForeignCategories()

ImagePage::getForeignCategories ( )

See also: WikiFilePage::getForeignCategories

Returns: TitleArray|Title[]

Definition at line 1209 of file ImagePage.php.

◆ getThumbPrevText()

ImagePage::getThumbPrevText	(		$params,
			$sizeLinkBigImagePreview )

protected

Make the text under the image to say what size preview.

Parameters

array	$params	parameters for thumbnail
string	$sizeLinkBigImagePreview	HTML for the current size

Returns: string HTML output

Definition at line 699 of file ImagePage.php.

References getContext().

Referenced by openShowImage().

◆ getThumbSizes()

ImagePage::getThumbSizes	(		$origWidth,
			$origHeight )

protected

Get alternative thumbnail sizes.

Note: This will only list several alternatives if thumbnails are rendered on 404

Parameters

int	$origWidth	Actual width of image
int	$origHeight	Actual height of image

Returns: int[][] An array of [width, height] pairs.

Definition at line 1154 of file ImagePage.php.

References getContext().

Referenced by openShowImage().

◆ getUploadUrl()

ImagePage::getUploadUrl ( )

Definition at line 789 of file ImagePage.php.

References getFile(), and loadFile().

Referenced by uploadLinksBox().

◆ imageDupes()

ImagePage::imageDupes ( )

protected

Definition at line 1008 of file ImagePage.php.

References $file, Article\$linkRenderer, getContext(), Article\getPage(), File\getRepo(), getTitle(), loadFile(), and MediaWiki\Linker\LinkRenderer\makeKnownLink().

Referenced by view().

◆ imageHistory()

ImagePage::imageHistory ( )

protected

If the page we've just displayed is in the "Image" namespace, we follow it with an upload history of the image and its usage.

Definition at line 845 of file ImagePage.php.

References getContext(), getFile(), loadFile(), and uploadLinksBox().

Referenced by view().

◆ imageLinks()

ImagePage::imageLinks ( )

protected

Definition at line 880 of file ImagePage.php.

References Article\$linkRenderer, getContext(), getTitle(), MediaWiki\Linker\LinkRenderer\makeKnownLink(), NS_FILE, and queryImageLinks().

Referenced by view().

◆ isLocal()

ImagePage::isLocal ( )

See also: WikiFilePage::isLocal

Returns: bool

Definition at line 1193 of file ImagePage.php.

Referenced by uploadLinksBox().

◆ loadFile()

ImagePage::loadFile ( )

protected

Definition at line 71 of file ImagePage.php.

References Article\getPage(), and getTitle().

Referenced by getDisplayedFile(), getUploadUrl(), imageDupes(), imageHistory(), openShowImage(), printSharedImageText(), uploadLinksBox(), and view().

◆ makeMetadataTable()

ImagePage::makeMetadataTable ( $metadata )

protected

Make a table with metadata to be shown in the output page.

Todo: FIXME: Bad interface, see note on MediaHandler::formatMetadata().

Parameters

array $metadata The array containing the Exif data

Returns: string The metadata table. This is treated as Wikitext (!)

Definition at line 299 of file ImagePage.php.

References getContext().

Referenced by view().

◆ makeSizeLink()

ImagePage::makeSizeLink	(	$params,
		$width,
		$height )

protected

Creates a thumbnail of specified size and returns an HTML link to it.

Parameters

array	$params	Scaler parameters
int	$width
int	$height

Returns: string

Definition at line 737 of file ImagePage.php.

Referenced by openShowImage().

◆ newPage()

ImagePage::newPage ( Title $title )

protected

Parameters

Title $title

Returns: WikiFilePage

Reimplemented from Article.

Definition at line 56 of file ImagePage.php.

◆ openShowImage()

ImagePage::openShowImage ( )

protected

◆ printSharedImageText()

ImagePage::printSharedImageText ( )

protected

Show a notice that the file is from a shared repository.

Definition at line 756 of file ImagePage.php.

References getContext(), FileRepo\getDisplayName(), getFile(), Article\getPage(), and loadFile().

Referenced by openShowImage().

◆ queryImageLinks()

ImagePage::queryImageLinks	(		$target,
			$limit )

protected

Parameters

string \| string[]	$target
int	$limit

Returns: IResultWrapper

Definition at line 869 of file ImagePage.php.

References DB_REPLICA, and wfGetDB().

Referenced by imageLinks().

◆ setFile()

ImagePage::setFile ( $file )

Parameters

File $file

Returns: void

Definition at line 65 of file ImagePage.php.

References $file, and Article\getPage().

◆ showError()

ImagePage::showError ( $description )

Display an error with a wikitext description.

Parameters

string $description

Definition at line 1050 of file ImagePage.php.

References getContext().

◆ showTOC()

ImagePage::showTOC ( $metadata )

protected

Create the TOC.

Parameters

bool $metadata Whether or not to show the metadata link

Returns: string

Definition at line 243 of file ImagePage.php.

References getContext().

Referenced by view().

◆ uploadLinksBox()

ImagePage::uploadLinksBox ( )

protected

Add the re-upload link (or message about not being able to re-upload) to the output.

Definition at line 801 of file ImagePage.php.

References getAuthority(), getContext(), getFile(), getTitle(), getUploadUrl(), isLocal(), and loadFile().

Referenced by imageHistory().

◆ view()

ImagePage::view ( )

This is the default action of the index.php entry point: just view the page of the given title.

Reimplemented from Article.

Definition at line 96 of file ImagePage.php.

References closeShowImage(), getContext(), getFile(), Article\getPage(), getTitle(), imageDupes(), imageHistory(), imageLinks(), Article\isDiffOnlyView(), loadFile(), makeMetadataTable(), NS_FILE, openShowImage(), and showTOC().

Member Data Documentation

◆ $mExtraDescription

string false ImagePage::$mExtraDescription = false

protected

Guaranteed to be HTML, {.

See also: File::getDescriptionText}

Definition at line 50 of file ImagePage.php.

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

includes/page/ImagePage.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ closeShowImage()

◆ compare()

◆ doRenderLangOpt()

◆ getDisplayedFile()

◆ getDuplicates()

◆ getFile()

◆ getForeignCategories()

◆ getThumbPrevText()

◆ getThumbSizes()

◆ getUploadUrl()

◆ imageDupes()

◆ imageHistory()

◆ imageLinks()

◆ isLocal()

◆ loadFile()

◆ makeMetadataTable()

◆ makeSizeLink()

◆ newPage()

◆ openShowImage()

◆ printSharedImageText()

◆ queryImageLinks()

◆ setFile()

◆ showError()

◆ showTOC()

◆ uploadLinksBox()

◆ view()

Member Data Documentation

◆ $mExtraDescription