MediaWiki\Actions\FileDeleteAction Class Reference

Handle file deletion. More...

Inherits DeleteAction.

Collaboration diagram for MediaWiki\Actions\FileDeleteAction:

Public Member Functions
	__construct (Article $article, IContextSource $context)
	Only public since 1.21. Stability: stable to call Parameters Article $article IContextSource $context
Public Member Functions inherited from DeleteAction
	getName ()
	Return the name of the action this object responds to.
	getRestriction ()
	Get the permission required to perform this action.
	onSubmit ( $data)
	Process the form on POST submission.
	onSuccess ()
	Do something exciting on successful processing of the form.
	show ()
	The basic pattern for actions is to display some sort of HTMLForm UI, maybe with some stuff underneath (history etc); to do some processing on submission of that form (delete, protect, etc) and to do something exciting on 'success', be that display something new or redirect to somewhere.
Public Member Functions inherited from FormAction
	doesWrites ()
Public Member Functions inherited from Action
	addHelpLink ( $to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators.
	getArticle ()
	Get a Article object.
	getAuthority ()
	Shortcut to get the Authority executing this instance.
	getContext ()
	Get the IContextSource in use here.
	getLanguage ()
	Shortcut to get the user Language being used for this instance.
	getOutput ()
	Get the OutputPage being used for this instance.
	getRequest ()
	Get the WebRequest being used for this instance.
	getSkin ()
	Shortcut to get the Skin being used for this instance.
	getTitle ()
	Shortcut to get the Title object from the page.
	getUser ()
	Shortcut to get the User being used for this instance.
	getWikiPage ()
	Get a WikiPage object.
	msg ( $key,... $params)
	Get a Message object with context set Parameters are the same as wfMessage()
	needsReadRights ()
	Indicates whether this action requires read rights.
	requiresUnblock ()
	Whether this action can still be executed by a blocked user.
	requiresWrite ()
	Indicates whether this action page write access to the wiki.
	setHookContainer (HookContainer $hookContainer)

Protected Member Functions
	checkCanExecute (User $user)
	Checks if the given user (identified by an object) can perform this action.
	getFormAction ()
	getFormMessages ()
	TODO Do we need all these messages to be different?
	getPageTitle ()
	Returns the name that goes in the <h1> page title.
	showFormWarnings ()
	tempDelete ()
Protected Member Functions inherited from DeleteAction
	alterForm (HTMLForm $form)
	Play with the HTMLForm if you need to more substantially.
	getDefaultReason ()
	Default reason to be used for the deletion form.
	getDeleteReason ()
	getFormFields ()
	getFormMsg (string $field)
	isSuppressionAllowed ()
	prepareOutputForForm ()
	showEditedWarning ()
	showEditReasonsLinks ()
	showLogEntries ()
	Show deletion log fragments pertaining to the current page.
	showSubpagesWarnings ()
	usesOOUI ()
	Whether the form should use OOUI.
Protected Member Functions inherited from FormAction
	getForm ()
	Get the HTMLForm to control behavior.
	postText ()
	preText ()
	Add pre- or post-text to the form.
Protected Member Functions inherited from Action
	getDescription ()
	Returns the description that goes below the <h1> element.
	getHookContainer ()
	getHookRunner ()
	setHeaders ()
	Set output headers for noindexing etc.
	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

Additional Inherited Members
Static Public Member Functions inherited from Action
static	factory (string $action, Article $article, ?IContextSource $context=null)
	Get an appropriate Action subclass for the given action.
static	getActionName (IContextSource $context)
	Get the action that will be executed, not necessarily the one passed passed through the "action" request parameter.
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.
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 null	$context
	IContextSource if specified; otherwise we'll use the Context from the Page.
array	$fields
	The fields used to create the HTMLForm.

Detailed Description

Handle file deletion.

Definition at line 43 of file FileDeleteAction.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Actions\FileDeleteAction::__construct	(	Article	$article,
		IContextSource	$context )

Only public since 1.21.

Stability: stable

to call

Parameters

Article	$article
IContextSource	$context

Reimplemented from DeleteAction.

Definition at line 54 of file FileDeleteAction.php.

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

Member Function Documentation

checkCanExecute()

MediaWiki\Actions\FileDeleteAction::checkCanExecute ( User $user )

protected

Checks if the given user (identified by an object) can perform this action.

Can be overridden by sub-classes with more complicated permissions schemes. Failures here must throw subclasses of ErrorPageError

Since

1.17

Stability: stable

to override

Parameters

User

$user

Exceptions

UserBlockedError|ReadOnlyError|PermissionsError

Reimplemented from Action.

Definition at line 229 of file FileDeleteAction.php.

getFormAction()

MediaWiki\Actions\FileDeleteAction::getFormAction ( )

protected

Returns

string

Reimplemented from DeleteAction.

Definition at line 218 of file FileDeleteAction.php.

getFormMessages()

MediaWiki\Actions\FileDeleteAction::getFormMessages ( )

protected

TODO Do we need all these messages to be different?

Returns

string[]

Reimplemented from DeleteAction.

Definition at line 241 of file FileDeleteAction.php.

getPageTitle()

MediaWiki\Actions\FileDeleteAction::getPageTitle ( )

protected

Returns the name that goes in the <h1> page title.

Since 1.41, returning a string from this method has been deprecated.

Stability: stable

to override

Returns

string|Message

Reimplemented from DeleteAction.

Definition at line 67 of file FileDeleteAction.php.

References Action\getTitle(), and Action\msg().

showFormWarnings()

MediaWiki\Actions\FileDeleteAction::showFormWarnings ( )

protected

Reimplemented from DeleteAction.

Definition at line 154 of file FileDeleteAction.php.

tempDelete()

MediaWiki\Actions\FileDeleteAction::tempDelete ( )

protected

Reimplemented from DeleteAction.

Definition at line 72 of file FileDeleteAction.php.

---

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

• includes/actions/FileDeleteAction.php