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 $page Calling with anything other then Article is deprecated since 1.35 IContextSource | null $context
Public Member Functions inherited from DeleteAction
	doesWrites ()
	Indicates whether this action may perform database writes.
	getName ()
	Return the name of the action this object responds to.
	onView ()
	Show something on GET request.
	show ()
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.
	getRestriction ()
	Get the permission required to perform this action.
	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 ()
	Whether this action requires the wiki not to be locked.

Protected Member Functions
	getDefaultReason ()
	Default reason to be used for the deletion form. Returns string
	getFormAction ()
	getFormMessages ()
	TODO Do we need all these messages to be different?
	runExecuteChecks ()
	Todo Should use Action::checkCanExecute instead
	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.
	showSubpagesWarnings ()
Protected Member Functions inherited from Action
	checkCanExecute (User $user)
	Checks if the given user (identified by an object) can perform this action.
	getDescription ()
	Returns the description that goes below the <h1> element.
	getHookContainer ()
	getHookRunner ()
	getPageTitle ()
	Returns the name that goes in the <h1> page title.
	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	exists (string $name)
	Check if a given action is recognised, even if it's disabled.
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.
WikiPage Article ImagePage CategoryPage Page	$page
	Page on which we're performing the action.

Detailed Description

Handle file deletion.

Definition at line 42 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	$page	Calling with anything other then Article is deprecated since 1.35
IContextSource | null	$context

Reimplemented from DeleteAction.

Definition at line 53 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 235 of file FileDeleteAction.php.

getFormAction()

MediaWiki\Actions\FileDeleteAction::getFormAction ( )

protected

Returns

string

Reimplemented from DeleteAction.

Definition at line 192 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 218 of file FileDeleteAction.php.

runExecuteChecks()

MediaWiki\Actions\FileDeleteAction::runExecuteChecks ( )

protected

Todo

Should use Action::checkCanExecute instead

Reimplemented from DeleteAction.

Definition at line 206 of file FileDeleteAction.php.

showFormWarnings()

MediaWiki\Actions\FileDeleteAction::showFormWarnings ( )

protected

Reimplemented from DeleteAction.

Definition at line 145 of file FileDeleteAction.php.

tempDelete()

MediaWiki\Actions\FileDeleteAction::tempDelete ( )

protected

Reimplemented from DeleteAction.

Definition at line 66 of file FileDeleteAction.php.

References $file.

---

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

• includes/actions/FileDeleteAction.php