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

Inheritance diagram for SpecialRevisionDelete:

[legend]

Collaboration diagram for SpecialRevisionDelete:

[legend]

Public Member Functions
	__construct (PermissionManager $permissionManager)

	doesWrites ()
	Indicates whether this special page may perform database writes.

	execute ( $par)
	Default execute method Checks user permissions.

Public Member Functions inherited from UnlistedSpecialPage
	__construct ( $name, $restriction='', $function=false, $file='default')

	isListed ()
	Whether this special page is listed in Special:SpecialPages.

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.

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

	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,... $params)
	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.

	prefixSearchSubpages ( $search, $limit, $offset)
	Return an array of subpages beginning with $search that this special page will accept.

	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.

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

Protected Member Functions
	addUsageText ()
	Show some introductory text.

	buildCheckBoxes ()

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

	failure ( $status)
	Report that the submit operation failed.

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

	getList ()
	Get the list object for this request.

	getLogQueryCond ()
	Get the condition used for fetching log snippets.

	save (array $bitPars, $reason)
	Do the write operations.

	showConvenienceLinks ()
	Show some useful links in the subtitle.

	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.

	submit ()
	UI entry point for form submission.

	success ()
	Report that the submit operation succeeded.

	tryShowFile ( $archiveName)
	Show a deleted file version requested by the visitor.

Protected Member Functions inherited from SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

	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.

	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.

Protected Attributes
bool	$wasSaved = false
	Was the DB modified in this request.

Protected Attributes inherited from SpecialPage
IContextSource	$mContext
	Current request context.

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Private Attributes
string	$archiveName
	Archive name, for reviewing deleted files.

array	$checks
	Array of checkbox specs (message, name, deletion bits)

array	$ids
	Target ID list.

bool	$mIsAllowed
	Whether user is allowed to perform the action.

string	$otherReason

PermissionManager	$permissionManager

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

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

Title	$targetObj
	Title object for target parameter.

string	$token
	Edit token for securing image views against XSS.

array	$typeLabels
	UI Labels about the current type.

string	$typeName
	Deletion type, may be revision, archive, oldimage, filearchive, logging.

Static Private Attributes
static	$UILabels
	UI labels for each type.

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

Detailed Description

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

Log items can also be hidden.

Definition at line 34 of file SpecialRevisionDelete.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialRevisionDelete::__construct ( PermissionManager $permissionManager )

Parameters

PermissionManager $permissionManager

Definition at line 120 of file SpecialRevisionDelete.php.

References $permissionManager.

Member Function Documentation

◆ addUsageText()

SpecialRevisionDelete::addUsageText ( )

protected

Show some introductory text.

Todo: FIXME: Wikimedia-specific policy text

Definition at line 511 of file SpecialRevisionDelete.php.

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

Referenced by showForm().

◆ buildCheckBoxes()

SpecialRevisionDelete::buildCheckBoxes ( )

protected

Returns: string HTML

Definition at line 533 of file SpecialRevisionDelete.php.

References $line, RevisionDeleter\extractBitfield(), extractBitParams(), getList(), SpecialPage\getRequest(), and SpecialPage\msg().

Referenced by showForm().

◆ doesWrites()

SpecialRevisionDelete::doesWrites ( )

Indicates whether this special page may perform database writes.

Returns: bool

Since: 1.27

Reimplemented from SpecialPage.

Definition at line 126 of file SpecialRevisionDelete.php.

◆ execute()

SpecialRevisionDelete::execute ( $subPage )

Default execute method Checks user permissions.

This must be overridden by subclasses; it will be made abstract in a future version

Parameters

string | null $subPage

Reimplemented from SpecialPage.

Definition at line 130 of file SpecialRevisionDelete.php.

References $ids, $permissionManager, $typeName, SpecialPage\checkPermissions(), SpecialPage\checkReadOnly(), RevisionDeleter\getCanonicalTypeName(), getList(), getLogQueryCond(), SpecialPage\getOutput(), SpecialPage\getRequest(), RevisionDeleter\getRestriction(), RevisionDeleter\getRevdelConstant(), SpecialPage\getUser(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), showConvenienceLinks(), showForm(), LogEventsList\showLogExtract(), submit(), RevisionDeleter\suggestTarget(), tryShowFile(), MediaWiki\Permissions\PermissionManager\userHasRight(), and SpecialPage\useTransactionalTimeLimit().

◆ extractBitParams()

SpecialRevisionDelete::extractBitParams ( )

protected

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

Returns: array

Definition at line 680 of file SpecialRevisionDelete.php.

References SpecialPage\getRequest().

Referenced by buildCheckBoxes(), and submit().

◆ failure()

SpecialRevisionDelete::failure ( $status )

protected

Report that the submit operation failed.

Parameters

Status $status

Definition at line 665 of file SpecialRevisionDelete.php.

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

Referenced by submit().

◆ getGroupName()

SpecialRevisionDelete::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 709 of file SpecialRevisionDelete.php.

◆ getList()

SpecialRevisionDelete::getList ( )

protected

Get the list object for this request.

Returns: RevDelList

Definition at line 382 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 304 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	$bitPars	ExtractBitParams() bitfield array
string	$reason

Returns: Status

Definition at line 703 of file SpecialRevisionDelete.php.

References getList().

Referenced by submit().

◆ showConvenienceLinks()

SpecialRevisionDelete::showConvenienceLinks ( )

protected

Show some useful links in the subtitle.

Definition at line 259 of file SpecialRevisionDelete.php.

References SpecialPage\$linkRenderer, SpecialPage\getLanguage(), SpecialPage\getLinkRenderer(), SpecialPage\getOutput(), getPermissionManager(), SpecialPage\getSkin(), SpecialPage\getTitleFor(), SpecialPage\getUser(), and SpecialPage\msg().

Referenced by execute().

◆ showForm()

SpecialRevisionDelete::showForm ( )

protected

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.

Definition at line 396 of file SpecialRevisionDelete.php.

References SpecialPage\addHelpLink(), addUsageText(), buildCheckBoxes(), SpecialPage\getLanguage(), SpecialPage\getLinkRenderer(), getList(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), getPermissionManager(), SpecialPage\getRequest(), getTitle(), SpecialPage\getUser(), and SpecialPage\msg().

Referenced by execute(), failure(), and success().

◆ submit()

SpecialRevisionDelete::submit ( )

protected

UI entry point for form submission.

Exceptions

PermissionsError

Returns: bool

Definition at line 605 of file SpecialRevisionDelete.php.

References $otherReason, $token, extractBitParams(), failure(), SpecialPage\getOutput(), getPermissionManager(), SpecialPage\getRequest(), SpecialPage\getUser(), SpecialPage\msg(), save(), and success().

Referenced by execute().

◆ success()

SpecialRevisionDelete::success ( )

protected

Report that the submit operation succeeded.

Definition at line 649 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 322 of file SpecialRevisionDelete.php.

References $archiveName, $lang, $path, SpecialPage\getLanguage(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), and SpecialPage\getUser().

Referenced by execute().

Member Data Documentation

◆ $archiveName

string SpecialRevisionDelete::$archiveName

private

Archive name, for reviewing deleted files.

Definition at line 45 of file SpecialRevisionDelete.php.

Referenced by tryShowFile().

◆ $checks

array SpecialRevisionDelete::$checks

private

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

Definition at line 57 of file SpecialRevisionDelete.php.

◆ $ids

array SpecialRevisionDelete::$ids

private

Target ID list.

Definition at line 42 of file SpecialRevisionDelete.php.

Referenced by execute(), and getLogQueryCond().

◆ $mIsAllowed

bool SpecialRevisionDelete::$mIsAllowed

private

Whether user is allowed to perform the action.

Definition at line 66 of file SpecialRevisionDelete.php.

◆ $otherReason

string SpecialRevisionDelete::$otherReason

private

Definition at line 69 of file SpecialRevisionDelete.php.

Referenced by submit().

◆ $permissionManager

PermissionManager SpecialRevisionDelete::$permissionManager

private

Definition at line 72 of file SpecialRevisionDelete.php.

Referenced by __construct(), and execute().

◆ $revDelList

RevDelList SpecialRevisionDelete::$revDelList

private

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

Definition at line 63 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 39 of file SpecialRevisionDelete.php.

◆ $targetObj

Title SpecialRevisionDelete::$targetObj

private

Title object for target parameter.

Definition at line 51 of file SpecialRevisionDelete.php.

◆ $token

string SpecialRevisionDelete::$token

private

Edit token for securing image views against XSS.

Definition at line 48 of file SpecialRevisionDelete.php.

Referenced by submit().

◆ $typeLabels

array SpecialRevisionDelete::$typeLabels

private

UI Labels about the current type.

Definition at line 60 of file SpecialRevisionDelete.php.

◆ $typeName

string SpecialRevisionDelete::$typeName

private

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

Definition at line 54 of file SpecialRevisionDelete.php.

Referenced by execute().

◆ $UILabels

SpecialRevisionDelete::$UILabels

staticprivate

UI labels for each type.

Definition at line 77 of file SpecialRevisionDelete.php.

◆ $wasSaved

bool SpecialRevisionDelete::$wasSaved = false

protected

Was the DB modified in this request.

Definition at line 36 of file SpecialRevisionDelete.php.

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

includes/specials/SpecialRevisionDelete.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addUsageText()

◆ buildCheckBoxes()

◆ doesWrites()

◆ execute()

◆ extractBitParams()

◆ failure()

◆ getGroupName()

◆ getList()

◆ getLogQueryCond()

◆ save()

◆ showConvenienceLinks()

◆ showForm()

◆ submit()

◆ success()

◆ tryShowFile()

Member Data Documentation

◆ $archiveName

◆ $checks

◆ $ids

◆ $mIsAllowed

◆ $otherReason

◆ $permissionManager

◆ $revDelList

◆ $submitClicked

◆ $targetObj

◆ $token

◆ $typeLabels

◆ $typeName

◆ $UILabels

◆ $wasSaved