MediaWiki master
MediaWiki\Specials\SpecialUndelete Class Reference

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

Inherits MediaWiki\SpecialPage\SpecialPage.

Collaboration diagram for MediaWiki\Specials\SpecialUndelete:

Public Member Functions

 __construct (PermissionManager $permissionManager, RevisionStore $revisionStore, RevisionRenderer $revisionRenderer, IContentHandlerFactory $contentHandlerFactory, NameTableStore $changeTagDefStore, LinkBatchFactory $linkBatchFactory, RepoGroup $repoGroup, IConnectionProvider $dbProvider, UserOptionsLookup $userOptionsLookup, WikiPageFactory $wikiPageFactory, SearchEngineFactory $searchEngineFactory, UndeletePageFactory $undeletePageFactory, ArchivedRevisionLookup $archivedRevisionLookup, CommentFormatter $commentFormatter, WatchlistManager $watchlistManager)
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError.
Stability: stable
to override
Since
1.19
Returns
void
Exceptions
PermissionsError

 
 doesWrites ()
 Indicates whether this special page may perform database writes.
 
 execute ( $par)
 Default execute method Checks user permissions.
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept.
 
 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 MediaWiki\SpecialPage\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.
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError.
 
 getAssociatedNavigationLinks ()
 Return an array of strings representing page titles that are discoverable to end users via UI.
 
 getAuthority ()
 Shortcut to get the Authority executing this instance.
 
 getConfig ()
 Shortcut to get main config object.
 
 getContentLanguage ()
 Shortcut to get content language.
 
 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 canonical, unlocalized name of this special page without namespace.
 
 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.
 
 getShortDescription (string $path='')
 Similar to getDescription but takes into account sub pages and designed for display in tabs.
 
 getSkin ()
 Shortcut to get the skin being used for this instance.
 
 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.
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included.
 
 msg ( $key,... $params)
 Wrapper around wfMessage that sets the current context.
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error.
 
 requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in or is a temporary user, throws UserNotLoggedIn.
 
 run ( $subPage)
 Entry point.
 
 setContentLanguage (Language $contentLanguage)
 Set content language.
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in.
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setSpecialPageFactory (SpecialPageFactory $specialPageFactory)
 

Protected Member Functions

 formatRevisionHistory (IResultWrapper $revisions)
 Generate the.
 
 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 ()
 
 showMoreHistory ()
 Handle XHR "show more history" requests (T249977)
 
- Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links.
 
 afterExecute ( $subPage)
 Gets called after.
 
 authorizeAction (?string $action=null)
 Utility function for authorizing an action to be performed by the special page.
 
 beforeExecute ( $subPage)
 Gets called before.
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging.
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process.
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have.
 
 getAuthManager ()
 
 getCacheTTL ()
 
 getHookContainer ()
 
 getHookRunner ()
 
 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.
 
 getSpecialPageFactory ()
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches.
 
 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.
 
 prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
 Perform a regular substring search for prefixSearchSubpages.
 
 setAuthManager (AuthManager $authManager)
 Set the injected AuthManager from the special page constructor.
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes!
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication.
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed.
 

Additional Inherited Members

- Static Public Member Functions inherited from MediaWiki\SpecialPage\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 newSearchPage (User $user)
 Get the users preferred search page.
 
- Static Protected Member Functions inherited from MediaWiki\SpecialPage\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 MediaWiki\SpecialPage\SpecialPage
IContextSource $mContext
 Current request context.
 
bool $mIncludable
 Whether the special page can be included in an article.
 
bool $mIncluding
 Whether or not this special page is being included from an article.
 
string $mName
 The canonical name of this special page Also used as the message key for the default.
 
string $mRestriction
 Minimum user level required to access this page, or "" for anyone.
 

Detailed Description

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

Definition at line 92 of file SpecialUndelete.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Specials\SpecialUndelete::__construct ( PermissionManager $permissionManager,
RevisionStore $revisionStore,
RevisionRenderer $revisionRenderer,
IContentHandlerFactory $contentHandlerFactory,
NameTableStore $changeTagDefStore,
LinkBatchFactory $linkBatchFactory,
RepoGroup $repoGroup,
IConnectionProvider $dbProvider,
UserOptionsLookup $userOptionsLookup,
WikiPageFactory $wikiPageFactory,
SearchEngineFactory $searchEngineFactory,
UndeletePageFactory $undeletePageFactory,
ArchivedRevisionLookup $archivedRevisionLookup,
CommentFormatter $commentFormatter,
WatchlistManager $watchlistManager )
Parameters
PermissionManager$permissionManager
RevisionStore$revisionStore
RevisionRenderer$revisionRenderer
IContentHandlerFactory$contentHandlerFactory
NameTableStore$changeTagDefStore
LinkBatchFactory$linkBatchFactory
RepoGroup$repoGroup
IConnectionProvider$dbProvider
UserOptionsLookup$userOptionsLookup
WikiPageFactory$wikiPageFactory
SearchEngineFactory$searchEngineFactory
UndeletePageFactory$undeletePageFactory
ArchivedRevisionLookup$archivedRevisionLookup
CommentFormatter$commentFormatter
WatchlistManager$watchlistManager

Definition at line 169 of file SpecialUndelete.php.

References RepoGroup\getLocalRepo().

Member Function Documentation

◆ checkPermissions()

MediaWiki\Specials\SpecialUndelete::checkPermissions ( )

Checks if userCanExecute, and if not throws a PermissionsError.

Stability: stable
to override
Since
1.19
Returns
void
Exceptions
PermissionsError

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 314 of file SpecialUndelete.php.

References MediaWiki\SpecialPage\SpecialPage\displayRestrictionError(), MediaWiki\SpecialPage\SpecialPage\getUser(), and MediaWiki\Specials\SpecialUndelete\userCanExecute().

Referenced by MediaWiki\Specials\SpecialUndelete\execute().

◆ doesWrites()

MediaWiki\Specials\SpecialUndelete::doesWrites ( )

Indicates whether this special page may perform database writes.

Stability: stable
to override
Returns
bool
Since
1.27

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 204 of file SpecialUndelete.php.

◆ execute()

◆ formatRevisionHistory()

MediaWiki\Specials\SpecialUndelete::formatRevisionHistory ( IResultWrapper $revisions)
protected

Generate the.

representing a list of deleted revisions

Parameters
IResultWrapper$revisions
Returns
string

Definition at line 998 of file SpecialUndelete.php.

References Wikimedia\Rdbms\IResultWrapper\fetchObject(), MediaWiki\Specials\SpecialUndelete\formatRevisionRow(), and Wikimedia\Rdbms\IResultWrapper\numRows().

Referenced by MediaWiki\Specials\SpecialUndelete\showHistory(), and MediaWiki\Specials\SpecialUndelete\showMoreHistory().

◆ formatRevisionRow()

◆ getGroupName()

MediaWiki\Specials\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'.

Stability: stable
to override
Returns
string
Since
1.21

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 1678 of file SpecialUndelete.php.

◆ isAllowed()

MediaWiki\Specials\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 294 of file SpecialUndelete.php.

References MediaWiki\SpecialPage\SpecialPage\getUser().

Referenced by MediaWiki\Specials\SpecialUndelete\showHistory(), and MediaWiki\Specials\SpecialUndelete\userCanExecute().

◆ prefixSearchSubpages()

MediaWiki\Specials\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 MediaWiki\SpecialPage\SpecialPage.

Definition at line 1674 of file SpecialUndelete.php.

References MediaWiki\SpecialPage\SpecialPage\prefixSearchString().

◆ showHistory()

◆ showMoreHistory()

MediaWiki\Specials\SpecialUndelete::showMoreHistory ( )
protected

Handle XHR "show more history" requests (T249977)

Definition at line 967 of file SpecialUndelete.php.

References MediaWiki\Specials\SpecialUndelete\formatRevisionHistory(), and MediaWiki\SpecialPage\SpecialPage\getOutput().

Referenced by MediaWiki\Specials\SpecialUndelete\execute().

◆ userCanExecute()

MediaWiki\Specials\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.

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

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 307 of file SpecialUndelete.php.

References MediaWiki\Specials\SpecialUndelete\isAllowed().

Referenced by MediaWiki\Specials\SpecialUndelete\checkPermissions().


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