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

Protected Member Functions

 formatRevisionRow ( $row, $earliestLiveTime, $remaining)
 
 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'.
 
 isAllowed ( $permission, User $user=null)
 Checks whether a user is allowed the permission for the specific title if one is set.
 
 showHistory ()
 
- Protected Member Functions inherited from SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links.
 
 afterExecute ( $subPage)
 Gets called after.
 
 beforeExecute ( $subPage)
 Gets called before.
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process.
 
 getCacheTTL ()
 
 getLoginSecurityLevel ()
 Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.
 
 getRobotPolicy ()
 Return the robot policy.
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches.
 
 prefixSearchString ( $search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages.
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication.
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed.
 

Private Member Functions

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

Private Attributes

 $mAction
 
 $mAllowed
 
 $mCanView
 
 $mComment
 
 $mFilename
 
 $mInvert
 
 $mRestore
 
 $mRevdel
 
string $mSearchPrefix
 Search prefix.
 
 $mTarget
 
Title $mTargetObj
 
 $mTargetTimestamp
 
 $mTimestamp
 
 $mToken
 

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.
 
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.
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name.
 
- 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).
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context.
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

Detailed Description

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

Definition at line 34 of file SpecialUndelete.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialUndelete::__construct ( )

Definition at line 55 of file SpecialUndelete.php.

Member Function Documentation

◆ diffHeader()

◆ doesWrites()

SpecialUndelete::doesWrites ( )

Indicates whether this special page may perform database writes.

Returns
bool
Since
1.27

Reimplemented from SpecialPage.

Definition at line 59 of file SpecialUndelete.php.

◆ execute()

SpecialUndelete::execute (   $subPage)

◆ 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 1129 of file SpecialUndelete.php.

References $link, 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 1074 of file SpecialUndelete.php.

References $link, $time, $user, 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 1106 of file SpecialUndelete.php.

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

Referenced by formatFileRow().

◆ getGroupName()

SpecialUndelete::getGroupName ( )
protected

Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

Returns
string
Since
1.21

Reimplemented from SpecialPage.

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

References $link, $rev, $time, $user, Revision\DELETED_TEXT, 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 137 of file SpecialUndelete.php.

References $user, and SpecialPage\getUser().

Referenced by formatFileRow(), loadRequest(), showHistory(), 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

Reimplemented from SpecialPage.

Definition at line 1208 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 217 of file SpecialUndelete.php.

References $matches, $query, as, 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
Returns
string HTML

Definition at line 542 of file SpecialUndelete.php.

References diffHeader(), Revision\FOR_THIS_USER, 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 661 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 633 of file SpecialUndelete.php.

References $lang, $out, $user, SpecialPage\getLanguage(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), and SpecialPage\getUser().

Referenced by execute().

◆ showHistory()

◆ showList()

SpecialUndelete::showList (   $result)
private

◆ showRevision()

◆ showSearchForm()

◆ undelete()

◆ userCanExecute()

SpecialUndelete::userCanExecute ( User  $user)

Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).

Can be overridden by sub- classes with more complicated permissions schemes.

Parameters
User$userThe user to check
Returns
bool Does the user have permission to view the page?

Reimplemented from SpecialPage.

Definition at line 146 of file SpecialUndelete.php.

References $user, and isAllowed().

Member Data Documentation

◆ $mAction

SpecialUndelete::$mAction
private

Definition at line 35 of file SpecialUndelete.php.

◆ $mAllowed

SpecialUndelete::$mAllowed
private

Definition at line 43 of file SpecialUndelete.php.

◆ $mCanView

SpecialUndelete::$mCanView
private

Definition at line 44 of file SpecialUndelete.php.

◆ $mComment

SpecialUndelete::$mComment
private

Definition at line 45 of file SpecialUndelete.php.

◆ $mFilename

SpecialUndelete::$mFilename
private

Definition at line 41 of file SpecialUndelete.php.

◆ $mInvert

SpecialUndelete::$mInvert
private

Definition at line 40 of file SpecialUndelete.php.

◆ $mRestore

SpecialUndelete::$mRestore
private

Definition at line 38 of file SpecialUndelete.php.

◆ $mRevdel

SpecialUndelete::$mRevdel
private

Definition at line 39 of file SpecialUndelete.php.

◆ $mSearchPrefix

string SpecialUndelete::$mSearchPrefix
private

Search prefix.

Definition at line 53 of file SpecialUndelete.php.

◆ $mTarget

SpecialUndelete::$mTarget
private

Definition at line 36 of file SpecialUndelete.php.

◆ $mTargetObj

Title SpecialUndelete::$mTargetObj
private

Definition at line 49 of file SpecialUndelete.php.

◆ $mTargetTimestamp

SpecialUndelete::$mTargetTimestamp
private

Definition at line 42 of file SpecialUndelete.php.

◆ $mTimestamp

SpecialUndelete::$mTimestamp
private

Definition at line 37 of file SpecialUndelete.php.

◆ $mToken

SpecialUndelete::$mToken
private

Definition at line 46 of file SpecialUndelete.php.


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