MediaWiki  master
SpecialUndelete Class Reference

Special page allowing users with the appropriate permissions to view and restore deleted content. More...

Inheritance diagram for SpecialUndelete:
Collaboration diagram for SpecialUndelete:

Public Member Functions

 __construct ()
 
 doesWrites ()
 
 execute ( $par)
 
 getFileComment ( $file)
 Fetch file upload comment if it's available to this user. More...
 
 getFileLink ( $file, $titleObj, $ts, $key)
 Fetch image view link if it's available to all users. More...
 
 getFileUser ( $file)
 Fetch file's user id if it's available to this user. More...
 
 getPageLink ( $rev, $titleObj, $ts)
 Fetch revision text link if it's available to all users. More...
 
 loadRequest ( $par)
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
 showDiff ( $previousRev, $currentRev)
 Build a diff display between this and the previous either deleted or non-deleted edit. More...
 
 showSearchForm ()
 
 undelete ()
 
 userCanExecute (User $user)
 
- Public Member Functions inherited from SpecialPage
 __construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
 Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called. More...
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError. More...
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError. More...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have. More...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 execute ( $subPage)
 Default execute method Checks user permissions. More...
 
 getConfig ()
 Shortcut to get main config object. More...
 
 getContext ()
 Gets the context this SpecialPage is executed in. More...
 
 getDescription ()
 Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages. More...
 
 getFinalGroupName ()
 Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side. More...
 
 getFullTitle ()
 Return the full title, including $par. More...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 getLinkRenderer ()
 
 getLocalName ()
 Get the localised name of the special page. More...
 
 getName ()
 Get the name of this Special Page. More...
 
 getOutput ()
 Get the OutputPage being used for this instance. More...
 
 getPageTitle ( $subpage=false)
 Get a self-referential title object. More...
 
 getRequest ()
 Get the WebRequest being used for this instance. More...
 
 getRestriction ()
 Get the permission that a user must have to execute this page. More...
 
 getSkin ()
 Shortcut to get the skin being used for this instance. More...
 
 getUser ()
 Shortcut to get the User executing this instance. More...
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion. More...
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode. More...
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. More...
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}}. More...
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages. More...
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes. More...
 
 listed ( $x=null)
 Get or set whether this special page is listed in Special:SpecialPages. More...
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included. More...
 
 msg ( $key,... $params)
 Wrapper around wfMessage that sets the current context. More...
 
 outputHeader ( $summaryMessageKey='')
 Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e. More...
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error. More...
 
 run ( $subPage)
 Entry point. More...
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! More...
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More...
 

Protected Member Functions

 formatRevisionRow ( $row, $earliestLiveTime, $remaining)
 
 getGroupName ()
 
 isAllowed ( $permission, User $user=null)
 Checks whether a user is allowed the permission for the specific title if one is set. More...
 
 showHistory ()
 
- Protected Member Functions inherited from SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links. More...
 
 afterExecute ( $subPage)
 Gets called after. More...
 
 beforeExecute ( $subPage)
 Gets called before. More...
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. More...
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process. More...
 
 getCacheTTL ()
 
 getGroupName ()
 Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'. More...
 
 getLoginSecurityLevel ()
 Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. More...
 
 getRobotPolicy ()
 Return the robot policy. More...
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches. More...
 
 prefixSearchString ( $search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Private Member Functions

 diffHeader ( $rev, $prefix)
 
 formatFileRow ( $row)
 
 redirectToRevDel ()
 Convert submitted form data to format expected by RevisionDelete and redirect the request. More...
 
 showFile ( $key)
 Show a deleted file version requested by the visitor. More...
 
 showFileConfirmationForm ( $key)
 Show a form confirming whether a tokenless user really wants to see a file. More...
 
 showList ( $result)
 Generic list of deleted pages. More...
 
 showRevision ( $timestamp)
 

Private Attributes

 $mAction
 
 $mAllowed
 
 $mCanView
 
 $mComment
 
bool null $mDiff
 
bool null $mDiffOnly
 
 $mFilename
 
int [] null $mFileVersions
 
 $mInvert
 
bool null $mPreview
 
 $mRestore
 
 $mRevdel
 
string $mSearchPrefix
 Search prefix. More...
 
 $mTarget
 
Title $mTargetObj
 
 $mTargetTimestamp
 
 $mTimestamp
 
 $mToken
 
bool null $mUnsuppress
 

Additional Inherited Members

- Static Public Member Functions inherited from SpecialPage
static getSafeTitleFor ( $name, $subpage=false)
 Get a localised Title object for a page name with a possibly unvalidated subpage. More...
 
static getTitleFor ( $name, $subpage=false, $fragment='')
 Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below. More...
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name. More...
 
- Static Protected Member Functions inherited from SpecialPage
static prefixSearchArray ( $search, $limit, array $subpages, $offset)
 Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query). More...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

Detailed Description

Special page allowing users with the appropriate permissions to view and restore deleted content.

Definition at line 35 of file SpecialUndelete.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialUndelete::__construct ( )

Definition at line 66 of file SpecialUndelete.php.

Member Function Documentation

◆ diffHeader()

◆ doesWrites()

SpecialUndelete::doesWrites ( )

Definition at line 70 of file SpecialUndelete.php.

◆ execute()

◆ formatFileRow()

◆ formatRevisionRow()

◆ getFileComment()

SpecialUndelete::getFileComment (   $file)

Fetch file upload comment if it's available to this user.

Parameters
File | ArchivedFile$file
Returns
string HTML fragment

Definition at line 1163 of file SpecialUndelete.php.

References $file, Linker\commentBlock(), File\DELETED_COMMENT, and SpecialPage\msg().

Referenced by formatFileRow().

◆ getFileLink()

SpecialUndelete::getFileLink (   $file,
  $titleObj,
  $ts,
  $key 
)

Fetch image view link if it's available to all users.

Parameters
File | ArchivedFile$file
Title$titleObj
string$tsA timestamp
string$keyA storage key
Returns
string HTML fragment

Definition at line 1108 of file SpecialUndelete.php.

References $file, File\DELETED_FILE, SpecialPage\getLanguage(), SpecialPage\getLinkRenderer(), and SpecialPage\getUser().

Referenced by formatFileRow().

◆ getFileUser()

SpecialUndelete::getFileUser (   $file)

Fetch file's user id if it's available to this user.

Parameters
File | ArchivedFile$file
Returns
string HTML fragment

Definition at line 1140 of file SpecialUndelete.php.

References $file, File\DELETED_USER, SpecialPage\msg(), Linker\userLink(), and Linker\userToolLinks().

Referenced by formatFileRow().

◆ getGroupName()

SpecialUndelete::getGroupName ( )
protected

Definition at line 1251 of file SpecialUndelete.php.

◆ getPageLink()

SpecialUndelete::getPageLink (   $rev,
  $titleObj,
  $ts 
)

Fetch revision text link if it's available to all users.

Parameters
Revision$rev
Title$titleObj
string$tsTimestamp
Returns
string

Definition at line 1073 of file SpecialUndelete.php.

References SpecialPage\getLanguage(), SpecialPage\getLinkRenderer(), and SpecialPage\getUser().

Referenced by formatRevisionRow().

◆ isAllowed()

SpecialUndelete::isAllowed (   $permission,
User  $user = null 
)
protected

Checks whether a user is allowed the permission for the specific title if one is set.

Parameters
string$permission
User | null$user
Returns
bool

Definition at line 151 of file SpecialUndelete.php.

References SpecialPage\getUser().

Referenced by formatFileRow(), loadRequest(), and userCanExecute().

◆ loadRequest()

SpecialUndelete::loadRequest (   $par)

◆ prefixSearchSubpages()

SpecialUndelete::prefixSearchSubpages (   $search,
  $limit,
  $offset 
)

Return an array of subpages beginning with $search that this special page will accept.

Parameters
string$searchPrefix to search for
int$limitMaximum number of results to return (usually 10)
int$offsetNumber of results to skip (usually 0)
Returns
string[] Matching subpages

Definition at line 1247 of file SpecialUndelete.php.

References SpecialPage\prefixSearchString().

◆ redirectToRevDel()

SpecialUndelete::redirectToRevDel ( )
private

Convert submitted form data to format expected by RevisionDelete and redirect the request.

Definition at line 237 of file SpecialUndelete.php.

References $matches, SpecialPage\getOutput(), SpecialPage\getRequest(), and SpecialPage\getTitleFor().

Referenced by execute().

◆ showDiff()

SpecialUndelete::showDiff (   $previousRev,
  $currentRev 
)

Build a diff display between this and the previous either deleted or non-deleted edit.

Parameters
Revision$previousRev
Revision$currentRev

Definition at line 573 of file SpecialUndelete.php.

References diffHeader(), WikiPage\factory(), SpecialPage\getContext(), and SpecialPage\getOutput().

Referenced by showRevision().

◆ showFile()

SpecialUndelete::showFile (   $key)
private

Show a deleted file version requested by the visitor.

Parameters
string$key

Definition at line 696 of file SpecialUndelete.php.

References $path, $response, SpecialPage\getOutput(), SpecialPage\getRequest(), and RepoGroup\singleton().

Referenced by execute().

◆ showFileConfirmationForm()

SpecialUndelete::showFileConfirmationForm (   $key)
private

Show a form confirming whether a tokenless user really wants to see a file.

Parameters
string$key

Definition at line 668 of file SpecialUndelete.php.

References $file, $lang, SpecialPage\getLanguage(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getUser(), SpecialPage\msg(), Xml\openElement(), and Xml\submitButton().

Referenced by execute().

◆ showHistory()

◆ showList()

SpecialUndelete::showList (   $result)
private

◆ showRevision()

◆ showSearchForm()

◆ undelete()

◆ userCanExecute()

SpecialUndelete::userCanExecute ( User  $user)

Definition at line 162 of file SpecialUndelete.php.

References isAllowed().

Member Data Documentation

◆ $mAction

SpecialUndelete::$mAction
private

Definition at line 36 of file SpecialUndelete.php.

◆ $mAllowed

SpecialUndelete::$mAllowed
private

Definition at line 44 of file SpecialUndelete.php.

◆ $mCanView

SpecialUndelete::$mCanView
private

Definition at line 45 of file SpecialUndelete.php.

◆ $mComment

SpecialUndelete::$mComment
private

Definition at line 46 of file SpecialUndelete.php.

◆ $mDiff

bool null SpecialUndelete::$mDiff
private

Definition at line 51 of file SpecialUndelete.php.

◆ $mDiffOnly

bool null SpecialUndelete::$mDiffOnly
private

Definition at line 53 of file SpecialUndelete.php.

◆ $mFilename

SpecialUndelete::$mFilename
private

Definition at line 42 of file SpecialUndelete.php.

◆ $mFileVersions

int [] null SpecialUndelete::$mFileVersions
private

Definition at line 57 of file SpecialUndelete.php.

◆ $mInvert

SpecialUndelete::$mInvert
private

Definition at line 41 of file SpecialUndelete.php.

◆ $mPreview

bool null SpecialUndelete::$mPreview
private

Definition at line 49 of file SpecialUndelete.php.

◆ $mRestore

SpecialUndelete::$mRestore
private

Definition at line 39 of file SpecialUndelete.php.

◆ $mRevdel

SpecialUndelete::$mRevdel
private

Definition at line 40 of file SpecialUndelete.php.

◆ $mSearchPrefix

string SpecialUndelete::$mSearchPrefix
private

Search prefix.

Definition at line 64 of file SpecialUndelete.php.

◆ $mTarget

SpecialUndelete::$mTarget
private

Definition at line 37 of file SpecialUndelete.php.

◆ $mTargetObj

Title SpecialUndelete::$mTargetObj
private

Definition at line 60 of file SpecialUndelete.php.

◆ $mTargetTimestamp

SpecialUndelete::$mTargetTimestamp
private

Definition at line 43 of file SpecialUndelete.php.

◆ $mTimestamp

SpecialUndelete::$mTimestamp
private

Definition at line 38 of file SpecialUndelete.php.

◆ $mToken

SpecialUndelete::$mToken
private

Definition at line 47 of file SpecialUndelete.php.

◆ $mUnsuppress

bool null SpecialUndelete::$mUnsuppress
private

Definition at line 55 of file SpecialUndelete.php.


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