MediaWiki  master
MediaWiki\Actions\FileDeleteAction Class Reference

Handle file deletion. More...

Inheritance diagram for MediaWiki\Actions\FileDeleteAction:
Collaboration diagram for MediaWiki\Actions\FileDeleteAction:

Public Member Functions

 __construct (Page $page, IContextSource $context=null)
 Only public since 1.21.
Stability: stable
to call
Parameters
Article | WikiPage | Page$pageCalling with anything other then Article is deprecated since 1.35
IContextSource | null$context
More...
 
- Public Member Functions inherited from DeleteAction
 doesWrites ()
 Indicates whether this action may perform database writes. More...
 
 getName ()
 Return the name of the action this object responds to. More...
 
 onView ()
 Show something on GET request. More...
 
 show ()
 
- Public Member Functions inherited from Action
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 getArticle ()
 Get a Article object. More...
 
 getContext ()
 Get the IContextSource in use here. More...
 
 getLanguage ()
 Shortcut to get the user Language being used for this instance. More...
 
 getOutput ()
 Get the OutputPage being used for this instance. More...
 
 getRequest ()
 Get the WebRequest being used for this instance. More...
 
 getRestriction ()
 Get the permission required to perform this action. More...
 
 getSkin ()
 Shortcut to get the Skin being used for this instance. More...
 
 getTitle ()
 Shortcut to get the Title object from the page. More...
 
 getUser ()
 Shortcut to get the User being used for this instance. More...
 
 getWikiPage ()
 Get a WikiPage object. More...
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 requiresUnblock ()
 Whether this action can still be executed by a blocked user. More...
 
 requiresWrite ()
 Whether this action requires the wiki not to be locked. More...
 

Protected Member Functions

 getDefaultReason ()
 Default reason to be used for the deletion form.
Returns
string
More...
 
 getFormAction ()
 
 getFormMessages ()
 TODO Do we need all these messages to be different? More...
 
 runExecuteChecks ()
 
Todo:
Should use Action::checkCanExecute instead
More...
 
 showFormWarnings ()
 
 tempDelete ()
 
- Protected Member Functions inherited from DeleteAction
 getDeleteReason ()
 
 getFormMsg (string $field)
 
 isSuppressionAllowed ()
 
 prepareOutput (Message $pageTitle)
 
 prepareOutputForForm ()
 
 showEditReasonsLinks ()
 
 showForm (string $reason)
 
 showLogEntries ()
 Show deletion log fragments pertaining to the current page. More...
 
- Protected Member Functions inherited from Action
 checkCanExecute (User $user)
 Checks if the given user (identified by an object) can perform this action. More...
 
 getDescription ()
 Returns the description that goes below the \<h1\> tag. More...
 
 getHookContainer ()
 
 getHookRunner ()
 
 getPageTitle ()
 Returns the name that goes in the \<h1\> page title. More...
 
 setHeaders ()
 Set output headers for noindexing etc. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Private Member Functions

 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...
 
 showConfirm ()
 Show the confirmation form. More...
 
 tempExecute (LocalFile $file)
 

Private Attributes

File $file
 
OldLocalFile null $oldFile
 Corresponding to oldImage, if applicable. More...
 
string $oldImage
 Descriptor for the old version of the image, if applicable. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Action
static exists (string $name)
 Check if a given action is recognised, even if it's disabled. More...
 
static factory (string $action, Article $article, IContextSource $context=null)
 Get an appropriate Action subclass for the given action. More...
 
static getActionName (IContextSource $context)
 Get the action that will be executed, not necessarily the one passed passed through the "action" request parameter. More...
 
- Protected Attributes inherited from DeleteAction
LinkRenderer $linkRenderer
 
ReadOnlyMode $readOnlyMode
 
UserOptionsLookup $userOptionsLookup
 
WatchlistManager $watchlistManager
 
const MSG_COMMENT = 'comment'
 
const MSG_EDIT_REASONS = 'edit-reasons'
 
const MSG_EDIT_REASONS_SUPPRESS = 'edit-reasons-suppress'
 
const MSG_LEGEND = 'legend'
 
const MSG_REASON_DROPDOWN = 'reason-dropdown'
 Constants used to localize form fields. More...
 
const MSG_REASON_DROPDOWN_OTHER = 'reason-dropdown-other'
 
const MSG_REASON_DROPDOWN_SUPPRESS = 'reason-dropdown-suppress'
 
const MSG_REASON_OTHER = 'reason-other'
 
const MSG_SUBMIT = 'submit'
 
- Protected Attributes inherited from Action
IContextSource $context
 IContextSource if specified; otherwise we'll use the Context from the Page. More...
 
array $fields
 The fields used to create the HTMLForm. More...
 
WikiPage Article ImagePage CategoryPage Page $page
 Page on which we're performing the action. More...
 

Detailed Description

Handle file deletion.

Definition at line 41 of file FileDeleteAction.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Actions\FileDeleteAction::__construct ( Page  $page,
IContextSource  $context = null 
)

Only public since 1.21.

Stability: stable
to call
Parameters
Article | WikiPage | Page$pageCalling with anything other then Article is deprecated since 1.35
IContextSource | null$context

Reimplemented from DeleteAction.

Definition at line 52 of file FileDeleteAction.php.

References Action\$context, Action\$page, Action\getArticle(), MediaWiki\MediaWikiServices\getInstance(), Action\getRequest(), and Action\getTitle().

Member Function Documentation

◆ getDefaultReason()

MediaWiki\Actions\FileDeleteAction::getDefaultReason ( )
protected

Default reason to be used for the deletion form.

Returns
string

Reimplemented from DeleteAction.

Definition at line 231 of file FileDeleteAction.php.

References Action\getRequest().

Referenced by MediaWiki\Actions\FileDeleteAction\showConfirm().

◆ getFormAction()

MediaWiki\Actions\FileDeleteAction::getFormAction ( )
protected
Returns
string

Reimplemented from DeleteAction.

Definition at line 188 of file FileDeleteAction.php.

References MediaWiki\Actions\FileDeleteAction\$oldImage, and Action\getTitle().

◆ getFormMessages()

MediaWiki\Actions\FileDeleteAction::getFormMessages ( )
protected

TODO Do we need all these messages to be different?

Returns
string[]

Reimplemented from DeleteAction.

Definition at line 214 of file FileDeleteAction.php.

◆ prepareMessage()

MediaWiki\Actions\FileDeleteAction::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$messageMessage base
Returns
string

Definition at line 165 of file FileDeleteAction.php.

References $lang, Action\getContext(), Action\getTitle(), PROTO_CURRENT, wfEscapeWikiText(), and wfExpandUrl().

Referenced by MediaWiki\Actions\FileDeleteAction\showFormWarnings(), and MediaWiki\Actions\FileDeleteAction\tempExecute().

◆ runExecuteChecks()

MediaWiki\Actions\FileDeleteAction::runExecuteChecks ( )
protected

Todo:
Should use Action::checkCanExecute instead

Reimplemented from DeleteAction.

Definition at line 202 of file FileDeleteAction.php.

References Action\getContext().

Referenced by MediaWiki\Actions\FileDeleteAction\tempExecute().

◆ showConfirm()

◆ showFormWarnings()

MediaWiki\Actions\FileDeleteAction::showFormWarnings ( )
protected

◆ tempDelete()

MediaWiki\Actions\FileDeleteAction::tempDelete ( )
protected

◆ tempExecute()

Member Data Documentation

◆ $file

File MediaWiki\Actions\FileDeleteAction::$file
private

◆ $oldFile

OldLocalFile null MediaWiki\Actions\FileDeleteAction::$oldFile
private

Corresponding to oldImage, if applicable.

Definition at line 47 of file FileDeleteAction.php.

◆ $oldImage

string MediaWiki\Actions\FileDeleteAction::$oldImage
private

Descriptor for the old version of the image, if applicable.

Definition at line 45 of file FileDeleteAction.php.

Referenced by MediaWiki\Actions\FileDeleteAction\getFormAction().


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