MediaWiki  master
ImagePage Class Reference

Class for viewing MediaWiki file description pages. More...

Inheritance diagram for ImagePage:
Collaboration diagram for ImagePage:

Public Member Functions

 getDisplayedFile ()
 
 getDuplicates ()
 
 getFile ()
 
 getForeignCategories ()
 
 getImageLimitsFromOption (UserIdentity $user, $optionName)
 Returns the corresponding $wgImageLimits entry for the selected user option. More...
 
 getUploadUrl ()
 
 isLocal ()
 
 setFile ( $file)
 
 showError ( $description)
 Display an error with a wikitext description. More...
 
 view ()
 This is the default action of the index.php entry point: just view the page of the given title. More...
 
- 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. More...
 
 adjustDisplayTitle (ParserOutput $pOutput)
 Adjust title for pages with displaytitle, -{T|}- or language conversion. More...
 
 clear ()
 
 doDelete ( $reason, $suppress=false, $immediate=false)
 Perform a deletion and output success or failure messages. More...
 
 fetchRevisionRecord ()
 Fetches the revision to work on. More...
 
 getActionOverrides ()
 Call to WikiPage function for backwards compatibility. More...
 
 getContext ()
 Gets the context this Article is executed in. More...
 
 getOldID ()
 
 getOldIDFromRequest ()
 Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect. More...
 
 getPage ()
 Get the WikiPage object of this instance. More...
 
 getParserOptions ()
 Get parser options suitable for rendering the primary article wikitext. More...
 
 getParserOutput ( $oldid=null, UserIdentity $user=null)
 #- More...
 
 getRedirectedFrom ()
 Get the page this view was redirected from. More...
 
 getRevIdFetched ()
 Use this to fetch the rev ID used on page views. More...
 
 getRobotPolicy ( $action, ParserOutput $pOutput=null)
 Get the robot policy to be used for the current view. More...
 
 getTimestamp ()
 
 getTitle ()
 Get the title object of the article. More...
 
 isCurrent ()
 Returns true if the currently-referenced revision is the current edit to this page (and it exists). More...
 
 isFileCacheable ( $mode=HTMLFileCache::MODE_NORMAL)
 Check if the page can be cached. More...
 
 protect ()
 action=protect handler More...
 
 render ()
 Handle action=render. More...
 
 setContext ( $context)
 Sets the context this Article is executed in. More...
 
 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 -\> More...
 
 setRedirectedFrom (Title $from)
 Tell the page view functions that this view was redirected from another page on the wiki. More...
 
 showDeletedRevisionHeader ()
 If the revision requested for view is deleted, check permissions. More...
 
 showMissingArticle ()
 Show the error text for a missing article. More...
 
 showNamespaceHeader ()
 Show a header specific to the namespace currently being viewed, like [[MediaWiki:Talkpagetext]]. More...
 
 showPatrolFooter ()
 If patrol is possible, output a patrol UI box. More...
 
 showRedirectedFromHeader ()
 If this request is a redirect view, send "redirected from" subtitle to the output. More...
 
 showViewFooter ()
 Show the footer section of an ordinary page view. More...
 
 unprotect ()
 action=unprotect handler (alias) More...
 
 viewRedirect ( $target, $appendSubtitle=true, $forceKnown=false)
 Return the HTML for the top of a redirect page. More...
 

Protected Member Functions

 closeShowImage ()
 For overloading. More...
 
 compare ( $a, $b)
 Callback for usort() to do link sorts by (namespace, title) Function copied from Title::compare() More...
 
 doRenderLangOpt (array $langChoices, $renderLang)
 Output a drop-down box for language options for the file. More...
 
 getThumbPrevText ( $params, $sizeLinkBigImagePreview)
 Make the text under the image to say what size preview. More...
 
 getThumbSizes ( $origWidth, $origHeight)
 Get alternative thumbnail sizes. More...
 
 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. More...
 
 imageLinks ()
 
 loadFile ()
 
 makeMetadataTable ( $metadata)
 Make a table with metadata to be shown in the output page. More...
 
 makeSizeLink ( $params, $width, $height)
 Creates an thumbnail of specified size and returns an HTML link to it. More...
 
 newPage (Title $title)
 
 openShowImage ()
 
 printSharedImageText ()
 Show a notice that the file is from a shared repository. More...
 
 queryImageLinks ( $target, $limit)
 
 showTOC ( $metadata)
 Create the TOC. More...
 
 uploadLinksBox ()
 Add the re-upload link (or message about not being able to re-upload) to the output. More...
 
- Protected Member Functions inherited from Article
 showDiffPage ()
 Show a diff page according to current request variables. More...
 
 tryFileCache ()
 checkLastModified returns true if it has taken care of all output to the client that is necessary for this request. More...
 

Protected Attributes

string false $mExtraDescription = false
 Guaranteed to be HTML, {. More...
 
- Protected Attributes inherited from Article
LinkRenderer $linkRenderer
 
IContextSource null $mContext
 The context this Article is executed in. More...
 
WikiPage $mPage
 The WikiPage object of this instance. More...
 
bool $viewIsRenderAction = false
 Whether render() was called. More...
 

Private Member Functions

 createXmlOptionStringForLanguage ( $lang, $selected)
 
 getLanguageForRendering (WebRequest $request, File $file)
 Returns language code to be used for dispaying the image, based on request context and languages available in the file. More...
 

Private Attributes

File false $displayImg
 Only temporary false, most code can assume this is a File. More...
 
bool $fileLoaded
 
FileRepo $repo
 

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(). More...
 
static getRedirectHeaderHtml (Language $lang, $target, $forceKnown=false)
 Return the HTML for the top of a redirect page. More...
 
static newFromID ( $id)
 Constructor from a page id. More...
 
static newFromTitle ( $title, IContextSource $context)
 Create an Article object of the appropriate class for the given page. More...
 
static newFromWikiPage (WikiPage $page, IContextSource $context)
 Create an Article object of the appropriate class for the given page. More...
 
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. More...
 
- Public Attributes inherited from Article
int null $mOldId
 The oldid of the article that was requested to be shown, 0 for the current revision. More...
 
ParserOutput null false $mParserOutput = null
 The ParserOutput generated for viewing the page, initialized by view(). More...
 
Title null $mRedirectedFrom = null
 Title from which we were redirected here, if any. More...
 
string bool $mRedirectUrl = false
 URL to redirect to or false if none. More...
 

Detailed Description

Class for viewing MediaWiki file description pages.

@method WikiFilePage getPage()

Definition at line 34 of file ImagePage.php.

Member Function Documentation

◆ closeShowImage()

ImagePage::closeShowImage ( )
protected

For overloading.

Definition at line 824 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$aObject page to compare with
stdClass$bObject page to compare with
Returns
int Result of string comparison, or namespace comparison

Definition at line 1056 of file ImagePage.php.

◆ createXmlOptionStringForLanguage()

ImagePage::createXmlOptionStringForLanguage (   $lang,
  $selected 
)
private
Parameters
string$lang
bool$selected
Returns
string

Definition at line 1126 of file ImagePage.php.

References $lang, LanguageCode\bcp47(), Article\getContext(), and Xml\option().

Referenced by doRenderLangOpt().

◆ doRenderLangOpt()

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

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

Parameters
array$langChoicesArray of string language codes
string$renderLangLanguage code for the language we want the file to rendered in.
Returns
string HTML to insert underneath image.

Definition at line 1081 of file ImagePage.php.

References $lang, $wgScript, createXmlOptionStringForLanguage(), Article\getContext(), Article\getTitle(), Html\hidden(), Xml\option(), Html\rawElement(), and Xml\submitButton().

Referenced by openShowImage().

◆ getDisplayedFile()

ImagePage::getDisplayedFile ( )
Returns
File

Definition at line 230 of file ImagePage.php.

References $displayImg, and loadFile().

Referenced by ImageHistoryList\__construct().

◆ getDuplicates()

ImagePage::getDuplicates ( )
See also
WikiFilePage::getDuplicates
Returns
File[]|null

Definition at line 1199 of file ImagePage.php.

References Article\getPage().

◆ getFile()

ImagePage::getFile ( )
See also
WikiFilePage::getFile
Returns
bool|File

Definition at line 1183 of file ImagePage.php.

References Article\getPage().

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

◆ getForeignCategories()

ImagePage::getForeignCategories ( )
See also
WikiFilePage::getForeignCategories
Returns
TitleArray|Title[]

Definition at line 1207 of file ImagePage.php.

References Article\getPage().

◆ getImageLimitsFromOption()

ImagePage::getImageLimitsFromOption ( UserIdentity  $user,
  $optionName 
)

Returns the corresponding $wgImageLimits entry for the selected user option.

Parameters
UserIdentity$user
string$optionNameName of a option to check, typically imagesize or thumbsize
Returns
int[]
Since
1.21
Deprecated:
Since 1.35 Use static function MediaFileTrait::getImageLimitsFromOption

Definition at line 1070 of file ImagePage.php.

Referenced by getThumbSizes(), and openShowImage().

◆ getLanguageForRendering()

ImagePage::getLanguageForRendering ( WebRequest  $request,
File  $file 
)
private

Returns language code to be used for dispaying the image, based on request context and languages available in the file.

Parameters
WebRequest$request
File$file
Returns
string|null

Definition at line 327 of file ImagePage.php.

References $file, and WebRequest\getVal().

Referenced by openShowImage().

◆ getThumbPrevText()

ImagePage::getThumbPrevText (   $params,
  $sizeLinkBigImagePreview 
)
protected

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

Parameters
array$paramsparameters for thumbnail
string$sizeLinkBigImagePreviewHTML for the current size
Returns
string HTML output

Definition at line 685 of file ImagePage.php.

References Article\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$origWidthActual width of image
int$origHeightActual height of image
Returns
int[][] An array of [width, height] pairs.

Definition at line 1153 of file ImagePage.php.

References $wgImageLimits, Article\getContext(), and getImageLimitsFromOption().

Referenced by openShowImage().

◆ getUploadUrl()

ImagePage::getUploadUrl ( )

Definition at line 775 of file ImagePage.php.

References getFile(), SpecialPage\getTitleFor(), and loadFile().

Referenced by uploadLinksBox().

◆ imageDupes()

ImagePage::imageDupes ( )
protected

◆ 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 831 of file ImagePage.php.

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

Referenced by view().

◆ imageLinks()

◆ isLocal()

ImagePage::isLocal ( )
See also
WikiFilePage::isLocal
Returns
bool

Definition at line 1191 of file ImagePage.php.

References Article\getPage().

Referenced by uploadLinksBox().

◆ loadFile()

ImagePage::loadFile ( )
protected

◆ 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$metadataThe array containing the Exif data
Returns
string The metadata table. This is treated as Wikitext (!)

Definition at line 297 of file ImagePage.php.

References $type, Article\getContext(), and Html\rawElement().

Referenced by view().

◆ makeSizeLink()

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

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

Parameters
array$paramsScaler parameters
int$width
int$height
Returns
string

Definition at line 723 of file ImagePage.php.

References Html\rawElement().

Referenced by openShowImage().

◆ newPage()

ImagePage::newPage ( Title  $title)
protected
Parameters
Title$title
Returns
WikiFilePage

Reimplemented from Article.

Definition at line 53 of file ImagePage.php.

References $title.

◆ openShowImage()

◆ printSharedImageText()

ImagePage::printSharedImageText ( )
protected

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

Definition at line 742 of file ImagePage.php.

References $repo, Article\getContext(), 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 855 of file ImagePage.php.

References $dbr, DB_REPLICA, and wfGetDB().

Referenced by imageLinks().

◆ setFile()

ImagePage::setFile (   $file)
Parameters
File$file
Returns
void

Definition at line 62 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 1039 of file ImagePage.php.

References Article\getContext().

◆ showTOC()

ImagePage::showTOC (   $metadata)
protected

Create the TOC.

Parameters
bool$metadataWhether or not to show the metadata link
Returns
string

Definition at line 241 of file ImagePage.php.

References Article\getContext(), and Html\rawElement().

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 787 of file ImagePage.php.

References Html\element(), getAuthority(), Article\getContext(), getFile(), Article\getTitle(), getUploadUrl(), isLocal(), loadFile(), Linker\makeExternalLink(), Html\rawElement(), and UploadBase\userCanReUpload().

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 91 of file ImagePage.php.

References $wgShowEXIF, Xml\closeElement(), closeShowImage(), Xml\element(), Article\getContext(), getFile(), Article\getOldID(), Article\getPage(), Article\getTitle(), imageDupes(), imageHistory(), imageLinks(), loadFile(), makeMetadataTable(), NS_FILE, Xml\openElement(), openShowImage(), Html\rawElement(), and showTOC().

Member Data Documentation

◆ $displayImg

File false ImagePage::$displayImg
private

Only temporary false, most code can assume this is a File.

Definition at line 38 of file ImagePage.php.

Referenced by getDisplayedFile().

◆ $fileLoaded

bool ImagePage::$fileLoaded
private

Definition at line 44 of file ImagePage.php.

◆ $mExtraDescription

string false ImagePage::$mExtraDescription = false
protected

Guaranteed to be HTML, {.

See also
File::getDescriptionText}

Definition at line 47 of file ImagePage.php.

◆ $repo

FileRepo ImagePage::$repo
private

Definition at line 41 of file ImagePage.php.

Referenced by printSharedImageText().


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