MediaWiki REL1_28
ImagePage Class Reference

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

Inheritance diagram for ImagePage:
Collaboration diagram for ImagePage:

Public Member Functions

 delete ()
 Delete the file, or an earlier version of it.
 
 getContentObject ()
 Overloading Article's getContentObject method.
 
 getDisplayedFile ()
 
 getDuplicates ()
 
 getFile ()
 
 getForeignCategories ()
 
 getImageLimitsFromOption ( $user, $optionName)
 Returns the corresponding $wgImageLimits entry for the selected user option.
 
 getUploadUrl ()
 
 isLocal ()
 
 render ()
 Handler for action=render Include body text only; none of the image extras.
 
 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)
 Constructor and clear the article.
 
 __get ( $fname)
 Use PHP's magic __get handler to handle accessing of raw WikiPage fields for backwards compatibility.
 
 __set ( $fname, $fvalue)
 Use PHP's magic __set handler to handle setting of raw WikiPage fields for backwards compatibility.
 
 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.
 
 checkFlags ( $flags)
 Call to WikiPage function for backwards compatibility.
 
 checkTouched ()
 Call to WikiPage function for backwards compatibility.
 
 clear ()
 Clear the object.
 
 clearPreparedEdit ()
 Call to WikiPage function for backwards compatibility.
 
 commitRollback ( $fromP, $summary, $bot, &$resultDetails, User $guser=null)
 
 confirmDelete ( $reason)
 Output deletion confirmation dialog.
 
 doDelete ( $reason, $suppress=false)
 Perform a deletion and output success or failure messages.
 
 doDeleteArticle ( $reason, $suppress=false, $u1=null, $u2=null, &$error='')
 
 doDeleteArticleReal ( $reason, $suppress=false, $u1=null, $u2=null, &$error='', User $user=null, $tags=[])
 Call to WikiPage function for backwards compatibility.
 
 doDeleteUpdates ( $id, Content $content=null)
 Call to WikiPage function for backwards compatibility.
 
 doEdit ( $text, $summary, $flags=0, $baseRevId=false, $user=null)
 Call to WikiPage function for backwards compatibility.
 
 doEditContent (Content $content, $summary, $flags=0, $baseRevId=false, User $user=null, $serialFormat=null)
 Call to WikiPage function for backwards compatibility.
 
 doEditUpdates (Revision $revision, User $user, array $options=[])
 Call to WikiPage function for backwards compatibility.
 
 doPurge ( $flags=WikiPage::PURGE_ALL)
 Call to WikiPage function for backwards compatibility.
 
 doRollback ( $fromP, $summary, $token, $bot, &$resultDetails, User $user=null)
 
 doUpdateRestrictions (array $limit, array $expiry, &$cascade, $reason, User $user)
 
 doViewUpdates (User $user, $oldid=0)
 Call to WikiPage function for backwards compatibility.
 
 exists ()
 Call to WikiPage function for backwards compatibility.
 
 fetchContent ()
 Get text of an article from database Does NOT follow redirects.
 
 followRedirect ()
 Call to WikiPage function for backwards compatibility.
 
 generateReason (&$hasHistory)
 
 getActionOverrides ()
 Call to WikiPage function for backwards compatibility.
 
 getAutoDeleteReason (&$hasHistory)
 Call to WikiPage function for backwards compatibility.
 
 getCategories ()
 Call to WikiPage function for backwards compatibility.
 
 getComment ( $audience=Revision::FOR_PUBLIC, User $user=null)
 Call to WikiPage function for backwards compatibility.
 
 getContent ()
 Note that getContent does not follow redirects anymore.
 
 getContentHandler ()
 Call to WikiPage function for backwards compatibility.
 
 getContentModel ()
 Call to WikiPage function for backwards compatibility.
 
 getContext ()
 Gets the context this Article is executed in.
 
 getContributors ()
 Call to WikiPage function for backwards compatibility.
 
 getCreator ( $audience=Revision::FOR_PUBLIC, User $user=null)
 Call to WikiPage function for backwards compatibility.
 
 getDeletionUpdates (Content $content=null)
 Call to WikiPage function for backwards compatibility.
 
 getHiddenCategories ()
 Call to WikiPage function for backwards compatibility.
 
 getId ()
 Call to WikiPage function for backwards compatibility.
 
 getLastPurgeTimestamp ()
 Call to WikiPage function for backwards compatibility.
 
 getLatest ()
 Call to WikiPage function for backwards compatibility.
 
 getLinksTimestamp ()
 Call to WikiPage function for backwards compatibility.
 
 getMinorEdit ()
 Call to WikiPage function for backwards compatibility.
 
 getOldestRevision ()
 Call to WikiPage function for backwards compatibility.
 
 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, User $user=null)
 #-
 
 getRedirectedFrom ()
 Get the page this view was redirected from.
 
 getRedirectTarget ()
 Call to WikiPage function for backwards compatibility.
 
 getRedirectURL ( $rt)
 Call to WikiPage function for backwards compatibility.
 
 getRevIdFetched ()
 Use this to fetch the rev ID used on page views.
 
 getRevision ()
 Call to WikiPage function for backwards compatibility.
 
 getRevisionFetched ()
 Get the fetched Revision object depending on request parameters or null on failure.
 
 getRobotPolicy ( $action, $pOutput=null)
 Get the robot policy to be used for the current view.
 
 getText ( $audience=Revision::FOR_PUBLIC, User $user=null)
 Call to WikiPage function for backwards compatibility.
 
 getTimestamp ()
 Call to WikiPage function for backwards compatibility.
 
 getTitle ()
 Get the title object of the article.
 
 getTouched ()
 Call to WikiPage function for backwards compatibility.
 
 getUndoContent (Revision $undo, Revision $undoafter=null)
 Call to WikiPage function for backwards compatibility.
 
 getUser ( $audience=Revision::FOR_PUBLIC, User $user=null)
 Call to WikiPage function for backwards compatibility.
 
 getUserText ( $audience=Revision::FOR_PUBLIC, User $user=null)
 Call to WikiPage function for backwards compatibility.
 
 hasViewableContent ()
 Call to WikiPage function for backwards compatibility.
 
 insertOn ( $dbw, $pageId=null)
 Call to WikiPage function for backwards compatibility.
 
 insertProtectNullRevision ( $revCommentMsg, array $limit, array $expiry, $cascade, $reason, $user=null)
 Call to WikiPage function for backwards compatibility.
 
 insertRedirect ()
 Call to WikiPage function for backwards compatibility.
 
 insertRedirectEntry (Title $rt, $oldLatest=null)
 Call to WikiPage function for backwards compatibility.
 
 isCountable ( $editInfo=false)
 Call to WikiPage function for backwards compatibility.
 
 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.
 
 isRedirect ()
 Call to WikiPage function for backwards compatibility.
 
 loadFromRow ( $data, $from)
 Call to WikiPage function for backwards compatibility.
 
 loadPageData ( $from='fromdb')
 Call to WikiPage function for backwards compatibility.
 
 lockAndGetLatest ()
 Call to WikiPage function for backwards compatibility.
 
 makeParserOptions ( $context)
 Call to WikiPage function for backwards compatibility.
 
 pageDataFromId ( $dbr, $id, $options=[])
 Call to WikiPage function for backwards compatibility.
 
 pageDataFromTitle ( $dbr, $title, $options=[])
 Call to WikiPage function for backwards compatibility.
 
 prepareContentForEdit (Content $content, $revision=null, User $user=null, $serialFormat=null, $useCache=true)
 Call to WikiPage function for backwards compatibility.
 
 prepareTextForEdit ( $text, $revid=null, User $user=null)
 Call to WikiPage function for backwards compatibility.
 
 protect ()
 action=protect handler
 
 protectDescription (array $limit, array $expiry)
 Call to WikiPage function for backwards compatibility.
 
 protectDescriptionLog (array $limit, array $expiry)
 Call to WikiPage function for backwards compatibility.
 
 replaceSectionAtRev ( $sectionId, Content $sectionContent, $sectionTitle='', $baseRevId=null)
 Call to WikiPage function for backwards compatibility.
 
 replaceSectionContent ( $sectionId, Content $sectionContent, $sectionTitle='', $edittime=null)
 Call to WikiPage function for backwards compatibility.
 
 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 -\>
 
 setParserOptions (ParserOptions $options)
 Override the ParserOptions used to render the primary article wikitext.
 
 setRedirectedFrom (Title $from)
 Tell the page view functions that this view was redirected from another page on the wiki.
 
 setTimestamp ( $ts)
 Call to WikiPage function for backwards compatibility.
 
 shouldCheckParserCache (ParserOptions $parserOptions, $oldId)
 Call to WikiPage function for backwards compatibility.
 
 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.
 
 supportsSections ()
 Call to WikiPage function for backwards compatibility.
 
 triggerOpportunisticLinksUpdate (ParserOutput $parserOutput)
 Call to WikiPage function for backwards compatibility.
 
 unprotect ()
 action=unprotect handler (alias)
 
 updateCategoryCounts (array $added, array $deleted, $id=0)
 Call to WikiPage function for backwards compatibility.
 
 updateIfNewerOn ( $dbw, $revision)
 Call to WikiPage function for backwards compatibility.
 
 updateRedirectOn ( $dbw, $redirectTitle, $lastRevIsRedirect=null)
 Call to WikiPage function for backwards compatibility.
 
 updateRestrictions ( $limit=[], $reason='', &$cascade=0, $expiry=[])
 
 updateRevisionOn ( $dbw, $revision, $lastRevision=null, $lastRevIsRedirect=null)
 Call to WikiPage function for backwards compatibility.
 
 viewRedirect ( $target, $appendSubtitle=true, $forceKnown=false)
 Return the HTML for the top of a redirect page.
 

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, $curLang, $defaultLang)
 Output a drop-down box for language options for the file.
 
 getDisplayWidthHeight ( $maxWidth, $maxHeight, $width, $height)
 Get the width and height to display image at.
 
 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.
 
 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 ()
 Print out the various links at the bottom of the image page, e.g.
 
- Protected Member Functions inherited from Article
 fetchContentObject ()
 Get text content object Does NOT follow redirects.
 
 showCssOrJsPage ( $showCacheHint=true)
 Show a page view for a page formatted as CSS or JavaScript.
 
 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

bool $mExtraDescription = false
 
WikiFilePage $mPage
 
- Protected Attributes inherited from Article
IContextSource $mContext
 The context this Article is executed in.
 
WikiPage $mPage
 The WikiPage object of this instance.
 

Private Member Functions

 getThumbPrevText ( $params, $sizeLinkBigImagePreview)
 Make the text under the image to say what size preview.
 
 makeSizeLink ( $params, $width, $height)
 Creates an thumbnail of specified size and returns an HTML link to it.
 

Private Attributes

File $displayImg
 
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().
 
static getAutosummary ( $oldtext, $newtext, $flags)
 
static getRedirectHeaderHtml (Language $lang, $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 onArticleCreate ( $title)
 
static onArticleDelete ( $title)
 
static onArticleEdit ( $title)
 
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.
 
static selectFields ()
 
- Public Attributes inherited from Article
string $mContent
 Text of the revision we are working on.
 
bool $mContentLoaded = false
 Is the content ($mContent) already loaded?
 
Content $mContentObject
 Content of the revision we are working on.
 
int null $mOldId
 The oldid of the article that is to be shown, 0 for the current revision.
 
ParserOptions $mParserOptions
 ParserOptions object for $wgUser articles.
 
ParserOutput $mParserOutput
 
Title $mRedirectedFrom = null
 Title from which we were redirected here.
 
string bool $mRedirectUrl = false
 URL to redirect to or false if none.
 
int $mRevIdFetched = 0
 Revision ID of revision we are working on.
 
Revision $mRevision = null
 Revision we are working on.
 

Detailed Description

Class for viewing MediaWiki file description pages.

Definition at line 28 of file ImagePage.php.

Member Function Documentation

◆ closeShowImage()

ImagePage::closeShowImage ( )
protected

For overloading.

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

Definition at line 1016 of file ImagePage.php.

◆ delete()

ImagePage::delete ( )

Delete the file, or an earlier version of it.

Reimplemented from Article.

Definition at line 982 of file ImagePage.php.

◆ doRenderLangOpt()

ImagePage::doRenderLangOpt ( array  $langChoices,
  $curLang,
  $defaultLang 
)
protected

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

Parameters
array$langChoicesArray of string language codes
string$curLangLanguage code file is being viewed in.
string$defaultLangLanguage code that image is rendered in by default
Returns
string HTML to insert underneath image.

Definition at line 1060 of file ImagePage.php.

References $code, $lang, $name, $wgScript, as, Article\getContext(), Article\getTitle(), global, Xml\option(), Xml\submitButton(), text, and wfBCP47().

Referenced by openShowImage().

◆ getContentObject()

ImagePage::getContentObject ( )

Overloading Article's getContentObject method.

Omit noarticletext if sharedupload; text will be fetched from the shared upload server if possible.

Returns
string

Reimplemented from Article.

Definition at line 289 of file ImagePage.php.

References loadFile().

◆ getDisplayedFile()

ImagePage::getDisplayedFile ( )
Returns
File

Definition at line 224 of file ImagePage.php.

References $displayImg, and loadFile().

Referenced by ImageHistoryList\__construct().

◆ getDisplayWidthHeight()

ImagePage::getDisplayWidthHeight (   $maxWidth,
  $maxHeight,
  $width,
  $height 
)
protected

Get the width and height to display image at.

Note
This method assumes that it is only called if one of the dimensions are bigger than the max, or if the image is vectorized.
Parameters
int$maxWidthMax width to display at
int$maxHeightMax height to display at
int$widthActual width of the image
int$heightActual height of the image
Exceptions
MWException
Returns
array Array (width, height)

Definition at line 1142 of file ImagePage.php.

Referenced by openShowImage().

◆ getDuplicates()

ImagePage::getDuplicates ( )
See also
WikiFilePage::getDuplicates
Returns
array|null

Definition at line 1224 of file ImagePage.php.

◆ getFile()

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

Definition at line 1208 of file ImagePage.php.

◆ getForeignCategories()

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

Definition at line 1232 of file ImagePage.php.

◆ getImageLimitsFromOption()

ImagePage::getImageLimitsFromOption (   $user,
  $optionName 
)

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

Parameters
User$user
string$optionNameName of a option to check, typically imagesize or thumbsize
Returns
array
Since
1.21

Definition at line 1032 of file ImagePage.php.

References $user, $wgImageLimits, and global.

Referenced by getThumbSizes(), and openShowImage().

◆ getThumbPrevText()

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

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

Parameters
$paramsarray parameters for thumbnail
$sizeLinkBigImagePreviewHTML for the current size
Returns
string HTML output

Definition at line 634 of file ImagePage.php.

References $params, Article\getContext(), and list.

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
array An array of [width, height] pairs.

Definition at line 1178 of file ImagePage.php.

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

Referenced by openShowImage().

◆ getUploadUrl()

ImagePage::getUploadUrl ( )

Definition at line 724 of file ImagePage.php.

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

References $out, Article\getContext(), loadFile(), and uploadLinksBox().

Referenced by view().

◆ imageLinks()

ImagePage::imageLinks ( )
protected

◆ isLocal()

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

Definition at line 1216 of file ImagePage.php.

◆ loadFile()

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

References $type, as, and Article\getContext().

Referenced by view().

◆ makeSizeLink()

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

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

References $params.

Referenced by openShowImage().

◆ newPage()

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

Reimplemented from Article.

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

References $out, $repo, Article\getContext(), FileRepo\getDisplayName(), loadFile(), and plain.

Referenced by openShowImage().

◆ queryImageLinks()

ImagePage::queryImageLinks (   $target,
  $limit 
)
protected
Parameters
string$target
int$limit
Returns
ResultWrapper

Definition at line 803 of file ImagePage.php.

References $dbr, $limit, DB_REPLICA, and wfGetDB().

Referenced by imageLinks().

◆ render()

ImagePage::render ( )

Handler for action=render Include body text only; none of the image extras.

Reimplemented from Article.

Definition at line 90 of file ImagePage.php.

References Article\getContext().

◆ setFile()

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

Definition at line 59 of file ImagePage.php.

◆ showError()

ImagePage::showError (   $description)

Display an error with a wikitext description.

Parameters
string$description

Definition at line 999 of file ImagePage.php.

References $out, and 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 235 of file ImagePage.php.

References Article\getContext().

Referenced by view().

◆ uploadLinksBox()

ImagePage::uploadLinksBox ( )
protected

Print out the various links at the bottom of the image page, e.g.

reupload, external editing (and instructions link) etc.

Definition at line 737 of file ImagePage.php.

References $out, $wgEnableUploads, Article\getContext(), Article\getTitle(), getUploadUrl(), Article\getUser(), global, loadFile(), Linker\makeExternalLink(), text, and UploadBase\userCanReUpload().

Referenced by imageHistory().

◆ view()

ImagePage::view ( )

Member Data Documentation

◆ $displayImg

File ImagePage::$displayImg
private

Definition at line 30 of file ImagePage.php.

Referenced by getDisplayedFile().

◆ $fileLoaded

bool ImagePage::$fileLoaded
private

Definition at line 36 of file ImagePage.php.

◆ $mExtraDescription

bool ImagePage::$mExtraDescription = false
protected

Definition at line 39 of file ImagePage.php.

◆ $mPage

WikiFilePage ImagePage::$mPage
protected

Definition at line 44 of file ImagePage.php.

◆ $repo

FileRepo ImagePage::$repo
private

Definition at line 33 of file ImagePage.php.

Referenced by printSharedImageText().


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