MediaWiki  master
SpecialRevisionDelete Class Reference

Special page allowing users with the appropriate permissions to view and hide revisions. More...

Inheritance diagram for SpecialRevisionDelete:
Collaboration diagram for SpecialRevisionDelete:

Public Member Functions

static __construct ()
 
 doesWrites ()
 
 execute ( $par)
 
- Public Member Functions inherited from UnlistedSpecialPage
 __construct ( $name, $restriction='', $function=false, $file='default')
 
 isListed ()
 
- 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...
 
 getTitle ( $subpage=false)
 Get a self-referential title object. 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)
 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

 addUsageText ()
 Show some introductory text. More...
 
 buildCheckBoxes ()
 
 extractBitParams ()
 Put together an array that contains -1, 0, or the *_deleted const for each bit. More...
 
 failure ( $status)
 Report that the submit operation failed. More...
 
 getGroupName ()
 
 getList ()
 Get the list object for this request. More...
 
 getLogQueryCond ()
 Get the condition used for fetching log snippets. More...
 
 save (array $bitPars, $reason)
 Do the write operations. More...
 
 showConvenienceLinks ()
 Show some useful links in the subtitle. More...
 
 showForm ()
 Show a list of items that we will operate on, and show a form with checkboxes which will allow the user to choose new visibility settings. More...
 
 submit ()
 UI entry point for form submission. More...
 
 success ()
 Report that the submit operation succeeded. More...
 
 tryShowFile ( $archiveName)
 Show a deleted file version requested by the visitor. More...
 
- 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...
 
 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...
 

Protected Attributes

bool $wasSaved = false
 Was the DB modified in this request. More...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

Private Attributes

string $archiveName
 Archive name, for reviewing deleted files. More...
 
array $checks
 Array of checkbox specs (message, name, deletion bits) More...
 
array $ids
 Target ID list. More...
 
bool $mIsAllowed
 Whether user is allowed to perform the action. More...
 
string $otherReason
 
RevDelList $revDelList
 RevDelList object, storing the list of items to be deleted/undeleted. More...
 
bool $submitClicked
 True if the submit button was clicked, and the form was posted. More...
 
Title $targetObj
 Title object for target parameter. More...
 
string $token
 Edit token for securing image views against XSS. More...
 
array $typeLabels
 UI Labels about the current type. More...
 
string $typeName
 Deletion type, may be revision, archive, oldimage, filearchive, logging. More...
 

Static Private Attributes

static $UILabels
 UI labels for each type. More...
 

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...
 

Detailed Description

Special page allowing users with the appropriate permissions to view and hide revisions.

Log items can also be hidden.

Definition at line 30 of file SpecialRevisiondelete.php.

Constructor & Destructor Documentation

◆ __construct()

static SpecialRevisionDelete::__construct ( )

Definition at line 108 of file SpecialRevisiondelete.php.

Member Function Documentation

◆ addUsageText()

SpecialRevisionDelete::addUsageText ( )
protected

Show some introductory text.

Todo:
FIXME: Wikimedia-specific policy text

Definition at line 492 of file SpecialRevisiondelete.php.

References SpecialPage\getOutput(), and SpecialPage\getUser().

Referenced by showForm().

◆ buildCheckBoxes()

SpecialRevisionDelete::buildCheckBoxes ( )
protected

◆ doesWrites()

SpecialRevisionDelete::doesWrites ( )

Definition at line 112 of file SpecialRevisiondelete.php.

◆ execute()

◆ extractBitParams()

SpecialRevisionDelete::extractBitParams ( )
protected

Put together an array that contains -1, 0, or the *_deleted const for each bit.

Returns
array

Definition at line 656 of file SpecialRevisiondelete.php.

References $name, as, Revision\DELETED_RESTRICTED, SpecialPage\getRequest(), and list.

Referenced by buildCheckBoxes(), and submit().

◆ failure()

SpecialRevisionDelete::failure (   $status)
protected

Report that the submit operation failed.

Parameters
Status$status

Definition at line 641 of file SpecialRevisiondelete.php.

References SpecialPage\getOutput(), SpecialPage\msg(), and showForm().

Referenced by submit().

◆ getGroupName()

SpecialRevisionDelete::getGroupName ( )
protected

Definition at line 685 of file SpecialRevisiondelete.php.

◆ getList()

SpecialRevisionDelete::getList ( )
protected

Get the list object for this request.

Returns
RevDelList

Definition at line 363 of file SpecialRevisiondelete.php.

References $revDelList, RevisionDeleter\createList(), and SpecialPage\getContext().

Referenced by buildCheckBoxes(), execute(), getLogQueryCond(), save(), and showForm().

◆ getLogQueryCond()

SpecialRevisionDelete::getLogQueryCond ( )
protected

Get the condition used for fetching log snippets.

Returns
array

Definition at line 285 of file SpecialRevisiondelete.php.

References $ids, getList(), and RevisionDeleter\getRelationType().

Referenced by execute().

◆ save()

SpecialRevisionDelete::save ( array  $bitPars,
  $reason 
)
protected

Do the write operations.

Simple wrapper for RevDel*List::setVisibility().

Parameters
array$bitParsExtractBitParams() bitfield array
string$reason
Returns
Status

Definition at line 679 of file SpecialRevisiondelete.php.

References getList().

Referenced by submit().

◆ showConvenienceLinks()

SpecialRevisionDelete::showConvenienceLinks ( )
protected

◆ showForm()

◆ submit()

SpecialRevisionDelete::submit ( )
protected

◆ success()

SpecialRevisionDelete::success ( )
protected

Report that the submit operation succeeded.

Definition at line 625 of file SpecialRevisiondelete.php.

References SpecialPage\getOutput(), SpecialPage\msg(), and showForm().

Referenced by submit().

◆ tryShowFile()

SpecialRevisionDelete::tryShowFile (   $archiveName)
protected

Show a deleted file version requested by the visitor.

Todo:
Mostly copied from Special:Undelete. Refactor.
Parameters
string$archiveName
Exceptions
MWException
PermissionsError

Definition at line 303 of file SpecialRevisiondelete.php.

References $archiveName, $lang, $path, $user, File\DELETED_FILE, File\DELETED_RESTRICTED, SpecialPage\getLanguage(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), SpecialPage\getUser(), SpecialPage\msg(), Xml\openElement(), RepoGroup\singleton(), Xml\submitButton(), and text.

Referenced by execute().

Member Data Documentation

◆ $archiveName

string SpecialRevisionDelete::$archiveName
private

Archive name, for reviewing deleted files.

Definition at line 41 of file SpecialRevisiondelete.php.

Referenced by tryShowFile().

◆ $checks

array SpecialRevisionDelete::$checks
private

Array of checkbox specs (message, name, deletion bits)

Definition at line 53 of file SpecialRevisiondelete.php.

◆ $ids

array SpecialRevisionDelete::$ids
private

Target ID list.

Definition at line 38 of file SpecialRevisiondelete.php.

Referenced by getLogQueryCond().

◆ $mIsAllowed

bool SpecialRevisionDelete::$mIsAllowed
private

Whether user is allowed to perform the action.

Definition at line 62 of file SpecialRevisiondelete.php.

◆ $otherReason

string SpecialRevisionDelete::$otherReason
private

Definition at line 65 of file SpecialRevisiondelete.php.

Referenced by submit().

◆ $revDelList

RevDelList SpecialRevisionDelete::$revDelList
private

RevDelList object, storing the list of items to be deleted/undeleted.

Definition at line 59 of file SpecialRevisiondelete.php.

Referenced by getList().

◆ $submitClicked

bool SpecialRevisionDelete::$submitClicked
private

True if the submit button was clicked, and the form was posted.

Definition at line 35 of file SpecialRevisiondelete.php.

◆ $targetObj

Title SpecialRevisionDelete::$targetObj
private

Title object for target parameter.

Definition at line 47 of file SpecialRevisiondelete.php.

◆ $token

string SpecialRevisionDelete::$token
private

Edit token for securing image views against XSS.

Definition at line 44 of file SpecialRevisiondelete.php.

◆ $typeLabels

array SpecialRevisionDelete::$typeLabels
private

UI Labels about the current type.

Definition at line 56 of file SpecialRevisiondelete.php.

◆ $typeName

string SpecialRevisionDelete::$typeName
private

Deletion type, may be revision, archive, oldimage, filearchive, logging.

Definition at line 50 of file SpecialRevisiondelete.php.

Referenced by execute().

◆ $UILabels

SpecialRevisionDelete::$UILabels
staticprivate
Initial value:
= [
'revision' => [
'check-label' => 'revdelete-hide-text'

UI labels for each type.

Definition at line 70 of file SpecialRevisiondelete.php.

◆ $wasSaved

bool SpecialRevisionDelete::$wasSaved = false
protected

Was the DB modified in this request.

Definition at line 32 of file SpecialRevisiondelete.php.


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