FileDeleteForm Class Reference

File deletion user interface. More...

Collaboration diagram for FileDeleteForm:

List of all members.

Public Member Functions
	__construct ($file)
	Constructor.
	execute ()
	Fulfil the request; shows the form or deletes the file, pending authentication, confirmation, etc.
Static Public Member Functions
static	doDelete (&$title, &$file, &$oldimage, $reason, $suppress, User $user=null)
	Really delete the file.
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?
static	isValidOldSpec ($oldimage)
	Is the provided `oldimage` value valid?
Private Member Functions
	getAction ()
	Prepare the form action.
	getTimestamp ()
	Extract the timestamp of the old version.
	prepareMessage ($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.
	setHeaders ()
	Set headers, titles and other bits.
	showForm ()
	Show the confirmation form.
	showLogEntries ()
	Show deletion log fragments pertaining to the current file.
Private Attributes
File	$file = null
File	$oldfile = null
	$oldimage = ''
Title	$title = null

---

Detailed Description

File deletion user interface.

Definition at line 30 of file FileDeleteForm.php.

---

Constructor & Destructor Documentation

FileDeleteForm::__construct

(

$

file

)

Constructor.

Parameters:

$file

File object we're deleting

Definition at line 50 of file FileDeleteForm.php.

---

Member Function Documentation

static FileDeleteForm::doDelete	(	&$	title,
		&$	file,
		&$	oldimage,
		$	reason,
		$	suppress,
		User $	user = null
	)		[static]

Really delete the file.

Parameters:

	$title	Title object
File	$file,:	file object
string	$oldimage	archive name
string	$reason	reason of the deletion
	$suppress	Boolean: whether to mark all deleted versions as restricted
	$user	User object performing the request

Exceptions:

MWException

Returns:

bool|Status

Definition at line 141 of file FileDeleteForm.php.

Referenced by ApiDelete\deleteFile(), UploadFromUrlTest\deleteFile(), and ApiTestCaseUpload\deleteFileByTitle().

FileDeleteForm::execute

(

)

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

Definition at line 59 of file FileDeleteForm.php.

FileDeleteForm::getAction

(

)

[private]

Prepare the form action.

Returns:

string

Definition at line 365 of file FileDeleteForm.php.

FileDeleteForm::getTimestamp

(

)

[private]

Extract the timestamp of the old version.

Returns:

string

Definition at line 381 of file FileDeleteForm.php.

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:

$file	File
$oldfile	File
$oldimage	File

Returns:

bool

Definition at line 354 of file FileDeleteForm.php.

static FileDeleteForm::isValidOldSpec

(

$

oldimage

)

[static]

Is the provided `oldimage` value valid?

Returns:

bool

Definition at line 338 of file FileDeleteForm.php.

Referenced by ApiDelete\deleteFile().

FileDeleteForm::prepareMessage

(

$

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 306 of file FileDeleteForm.php.

FileDeleteForm::setHeaders

(

)

[private]

Set headers, titles and other bits.

Definition at line 326 of file FileDeleteForm.php.

FileDeleteForm::showForm

(

)

[private]

Show the confirmation form.

Definition at line 204 of file FileDeleteForm.php.

FileDeleteForm::showLogEntries

(

)

[private]

Show deletion log fragments pertaining to the current file.

Definition at line 291 of file FileDeleteForm.php.

---

Member Data Documentation

File FileDeleteForm::$file = null [private]

Definition at line 38 of file FileDeleteForm.php.

File FileDeleteForm::$oldfile = null [private]

Definition at line 42 of file FileDeleteForm.php.

FileDeleteForm::$oldimage = '' [private]

Definition at line 43 of file FileDeleteForm.php.

Title FileDeleteForm::$title = null [private]

Definition at line 34 of file FileDeleteForm.php.

---

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

• includes/FileDeleteForm.php