File deletion user interface. More...

Collaboration diagram for FileDeleteForm:

[legend]

Public Member Functions
	__construct (LocalFile $file, IContextSource $context, ReadOnlyMode $readOnlyMode, RepoGroup $repoGroup, WatchlistManager $watchlistManager, LinkRenderer $linkRenderer, UserOptionsLookup $userOptionsLookup)

	execute ()
	Fulfil the request; shows the form or deletes the file, pending authentication, confirmation, etc. More...

Static Public Member Functions
static	doDelete (&$title, &$file, &$oldimage, $reason, $suppress, UserIdentity $user, $tags=[])
	Really delete the file. More...

static	haveDeletableFile (&$file, &$oldfile, $oldimage)
	Could we delete the file specified? If an `oldimage` value was provided, does it correspond to an existing, local, old version of this file? More...

static	isValidOldSpec ( $oldimage)
	Is the provided `oldimage` value valid? More...

Private Member Functions
	getAction ()
	Prepare the form action. More...

	getTimestamp ()
	Extract the timestamp of the old version. More...

	prepareMessage (string $message)
	Prepare a message referring to the file being deleted, showing an appropriate message depending upon whether it's a current file or an old version. More...

	setHeaders ()
	Set headers, titles and other bits. More...

	showForm ()
	Show the confirmation form. More...

	showLogEntries ()
	Show deletion log fragments pertaining to the current file. More...

Private Attributes
IContextSource	$context

LocalFile	$file

LinkRenderer	$linkRenderer

LocalFile null	$oldfile = null

string	$oldimage = ''

ReadOnlyMode	$readOnlyMode

RepoGroup	$repoGroup

Title	$title

UserOptionsLookup	$userOptionsLookup

WatchlistManager	$watchlistManager

Detailed Description

File deletion user interface.

Definition at line 38 of file FileDeleteForm.php.

Constructor & Destructor Documentation

◆ __construct()

FileDeleteForm::__construct	(	LocalFile	$file,
		IContextSource	$context,
		ReadOnlyMode	$readOnlyMode,
		RepoGroup	$repoGroup,
		WatchlistManager	$watchlistManager,
		LinkRenderer	$linkRenderer,
		UserOptionsLookup	$userOptionsLookup
	)

Parameters

LocalFile	$file	File object we're deleting
IContextSource	$context
ReadOnlyMode	$readOnlyMode
RepoGroup	$repoGroup
WatchlistManager	$watchlistManager
LinkRenderer	$linkRenderer
UserOptionsLookup	$userOptionsLookup

Definition at line 79 of file FileDeleteForm.php.

References $context, $file, $linkRenderer, $readOnlyMode, $repoGroup, $userOptionsLookup, $watchlistManager, and File\getTitle().

Member Function Documentation

◆ doDelete()

static FileDeleteForm::doDelete	(	&	$title,
		&	$file,
		&	$oldimage,
			$reason,
			$suppress,
		UserIdentity	$user,
			$tags = `[]`
	)

static

Really delete the file.

Parameters

Title	&$title
LocalFile	&$file
	?string	&$oldimage Archive name
string	$reason	Reason of the deletion
bool	$suppress	Whether to mark all deleted versions as restricted
UserIdentity	$user
string[]	$tags	Tags to apply to the deletion action

Exceptions

MWException

Returns: Status

Definition at line 210 of file FileDeleteForm.php.

References $file, $oldimage, $title, DB_PRIMARY, LocalFile\deleteFile(), LocalFile\deleteOldFile(), Title\getPrefixedText(), StatusValue\newFatal(), Hooks\runner(), wfEscapeWikiText(), wfGetDB(), and wfMessage().

Referenced by ApiDelete\deleteFile(), and execute().

◆ execute()

FileDeleteForm::execute ( )

Fulfil the request; shows the form or deletes the file, pending authentication, confirmation, etc.

Definition at line 102 of file FileDeleteForm.php.

References doDelete(), Title\newMainPage(), prepareMessage(), setHeaders(), showForm(), and showLogEntries().

◆ getAction()

FileDeleteForm::getAction ( )

private

Prepare the form action.

Returns: string

Definition at line 555 of file FileDeleteForm.php.

References $oldimage.

Referenced by showForm().

◆ getTimestamp()

FileDeleteForm::getTimestamp ( )

private

Extract the timestamp of the old version.

Returns: string

Definition at line 571 of file FileDeleteForm.php.

◆ haveDeletableFile()

static FileDeleteForm::haveDeletableFile	(	&	$file,
		&	$oldfile,
			$oldimage
	)

static

Could we delete the file specified? If an oldimage value was provided, does it correspond to an existing, local, old version of this file?

Parameters

LocalFile	&$file
LocalFile	&$oldfile
string	$oldimage

Returns: bool

Definition at line 544 of file FileDeleteForm.php.

References $file, $oldfile, $oldimage, LocalFile\exists(), and File\isLocal().

◆ isValidOldSpec()

static FileDeleteForm::isValidOldSpec ( $oldimage )

static

Is the provided oldimage value valid?

Parameters

string $oldimage

Returns: bool

Definition at line 528 of file FileDeleteForm.php.

References $oldimage.

Referenced by ApiDelete\deleteFile().

◆ prepareMessage()

FileDeleteForm::prepareMessage ( string $message )

private

Prepare a message referring to the file being deleted, showing an appropriate message depending upon whether it's a current file or an old version.

Parameters

string $message Message base

Returns: string

Definition at line 493 of file FileDeleteForm.php.

References $lang, PROTO_CURRENT, wfEscapeWikiText(), and wfExpandUrl().

Referenced by execute(), and showForm().

◆ setHeaders()

FileDeleteForm::setHeaders ( )

private

Set headers, titles and other bits.

Definition at line 516 of file FileDeleteForm.php.

Referenced by execute().

◆ showForm()

FileDeleteForm::showForm ( )

private

Show the confirmation form.

Definition at line 305 of file FileDeleteForm.php.

References CommentStore\COMMENT_CHARACTER_LIMIT, getAction(), Html\hidden(), Xml\listDropDownOptions(), Xml\listDropDownOptionsOoui(), and prepareMessage().

Referenced by execute().

◆ showLogEntries()

FileDeleteForm::showLogEntries ( )

private

Show deletion log fragments pertaining to the current file.

Definition at line 477 of file FileDeleteForm.php.

References LogEventsList\showLogExtract().

Referenced by execute().

Member Data Documentation

◆ $context

IContextSource FileDeleteForm::$context

private

Definition at line 53 of file FileDeleteForm.php.

Referenced by __construct().

◆ $file

LocalFile FileDeleteForm::$file

private

Definition at line 44 of file FileDeleteForm.php.

Referenced by __construct(), doDelete(), and haveDeletableFile().

◆ $linkRenderer

LinkRenderer FileDeleteForm::$linkRenderer

private

Definition at line 65 of file FileDeleteForm.php.

Referenced by __construct().

◆ $oldfile

LocalFile null FileDeleteForm::$oldfile = null

private

Definition at line 47 of file FileDeleteForm.php.

Referenced by haveDeletableFile().

◆ $oldimage

string FileDeleteForm::$oldimage = ''

private

Definition at line 50 of file FileDeleteForm.php.

Referenced by doDelete(), getAction(), haveDeletableFile(), and isValidOldSpec().

◆ $readOnlyMode

ReadOnlyMode FileDeleteForm::$readOnlyMode

private

Definition at line 56 of file FileDeleteForm.php.

Referenced by __construct().

◆ $repoGroup

RepoGroup FileDeleteForm::$repoGroup

private

Definition at line 59 of file FileDeleteForm.php.

Referenced by __construct().

◆ $title

Title FileDeleteForm::$title

private

Definition at line 41 of file FileDeleteForm.php.

Referenced by doDelete().

◆ $userOptionsLookup

UserOptionsLookup FileDeleteForm::$userOptionsLookup

private

Definition at line 68 of file FileDeleteForm.php.

Referenced by __construct().

◆ $watchlistManager

WatchlistManager FileDeleteForm::$watchlistManager

private

Definition at line 62 of file FileDeleteForm.php.

Referenced by __construct().

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

includes/FileDeleteForm.php

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doDelete()

◆ execute()

◆ getAction()

◆ getTimestamp()

◆ haveDeletableFile()

◆ isValidOldSpec()

◆ prepareMessage()

◆ setHeaders()

◆ showForm()

◆ showLogEntries()

Member Data Documentation

◆ $context

◆ $file

◆ $linkRenderer

◆ $oldfile

◆ $oldimage

◆ $readOnlyMode

◆ $repoGroup

◆ $title

◆ $userOptionsLookup

◆ $watchlistManager