MediaWiki  master
FileDeleteForm Class Reference

File deletion user interface. More...

Collaboration diagram for FileDeleteForm:

Public Member Functions

 __construct ( $file)
 
 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, User $user=null, $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 ( $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

File $file = null
 
File $oldfile = null
 
 $oldimage = ''
 
Title $title = null
 

Detailed Description

File deletion user interface.

Definition at line 31 of file FileDeleteForm.php.

Constructor & Destructor Documentation

◆ __construct()

FileDeleteForm::__construct (   $file)
Parameters
File$fileFile object we're deleting

Definition at line 52 of file FileDeleteForm.php.

References $file, file, File\getTitle(), and title.

Member Function Documentation

◆ doDelete()

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

Really delete the file.

Parameters
Title&$title
File&$file
string&$oldimageArchive name
string$reasonReason of the deletion
bool$suppressWhether to mark all deleted versions as restricted
User | null$userUser object performing the request
array$tagsTags to apply to the deletion action
Exceptions
MWException
Returns
Status

Definition at line 157 of file FileDeleteForm.php.

References $oldimage, $user, DB_MASTER, File\delete(), WikiPage\factory(), Title\getPrefixedText(), StatusValue\newFatal(), null, Hooks\run(), use, wfEscapeWikiText(), wfGetDB(), and wfMessage().

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

◆ execute()

FileDeleteForm::execute ( )

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

Definition at line 61 of file FileDeleteForm.php.

References $title, $wgOut, $wgRequest, $wgUploadMaintenance, WatchAction\doWatchOrUnwatch(), file, Title\newMainPage(), prepareMessage(), setHeaders(), showForm(), showLogEntries(), RepoGroup\singleton(), title, wfMessage(), and wfReadOnly().

◆ getAction()

FileDeleteForm::getAction ( )
private

Prepare the form action.

Returns
string

Definition at line 465 of file FileDeleteForm.php.

References $oldimage, and title.

Referenced by showForm().

◆ getTimestamp()

FileDeleteForm::getTimestamp ( )
private

Extract the timestamp of the old version.

Returns
string

Definition at line 481 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
File&$file
File&$oldfile
File$oldimage
Returns
bool

Definition at line 454 of file FileDeleteForm.php.

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

◆ isValidOldSpec()

static FileDeleteForm::isValidOldSpec (   $oldimage)
static

Is the provided oldimage value valid?

Parameters
string$oldimage
Returns
bool

Definition at line 438 of file FileDeleteForm.php.

References $oldimage.

Referenced by ApiDelete\deleteFile().

◆ prepareMessage()

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$messageMessage base
Returns
string

Definition at line 403 of file FileDeleteForm.php.

References $wgLang, file, PROTO_CURRENT, title, true, wfEscapeWikiText(), wfExpandUrl(), and wfMessage().

Referenced by execute(), and showForm().

◆ setHeaders()

FileDeleteForm::setHeaders ( )
private

Set headers, titles and other bits.

Definition at line 425 of file FileDeleteForm.php.

References $wgOut, title, and wfMessage().

Referenced by execute().

◆ showForm()

FileDeleteForm::showForm ( )
private

◆ showLogEntries()

FileDeleteForm::showLogEntries ( )
private

Show deletion log fragments pertaining to the current file.

Definition at line 388 of file FileDeleteForm.php.

References $wgOut, LogEventsList\showLogExtract(), and title.

Referenced by execute().

Member Data Documentation

◆ $file

File FileDeleteForm::$file = null
private

Definition at line 41 of file FileDeleteForm.php.

Referenced by __construct().

◆ $oldfile

File FileDeleteForm::$oldfile = null
private

Definition at line 46 of file FileDeleteForm.php.

◆ $oldimage

FileDeleteForm::$oldimage = ''
private

Definition at line 47 of file FileDeleteForm.php.

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

◆ $title

Title FileDeleteForm::$title = null
private

Definition at line 36 of file FileDeleteForm.php.

Referenced by execute().


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