Handle page deletion. More...

Inherits MediaWiki\Actions\FormAction.

Inherited by MediaWiki\Actions\FileDeleteAction.

Collaboration diagram for MediaWiki\Actions\DeleteAction:

[legend]

Public Member Functions

__construct (Article $article, IContextSource $context)

getName ()

Return the name of the action this object responds to.

Since: 1.17

Returns: string Lowercase name

getRestriction ()

Get the permission required to perform this action.Often, but not always, the same as the action nameImplementations of this methods must always return the same value, regardless of parameters passed to the constructor or system state.

Since: 1.17

Stability: stable: to override

Returns: string|null

onSubmit ( $data)

Process the form on POST submission.If you don't want to do anything with the form, just return false here.This method will be passed to the HTMLForm as a submit callback (see HTMLForm::setSubmitCallback) and must return as documented for HTMLForm::trySubmit.

See also: HTMLForm::setSubmitCallback(); HTMLForm::trySubmit()

Parameters

array $data

Returns: bool|string|array|Status Must return as documented for HTMLForm::trySubmit

onSuccess ()

Do something exciting on successful processing of the form.This might be to show a confirmation message (watch, rollback, etc) or to redirect somewhere else (edit, protect, etc).

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 MediaWiki\Actions\FormAction

doesWrites ()

Public Member Functions inherited from MediaWiki\Actions\Action

__construct (private readonly Article $article, protected readonly IContextSource $context,)

Only public since 1.21.

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
	alterForm (HTMLForm $form)
	Play with the HTMLForm if you need to more substantially.

	getDefaultReason ()
	Default reason to be used for the deletion form.

	getDeleteReason ()

	getFormAction ()

	getFormFields ()
	Get an HTMLForm descriptor array.

	getFormMessages ()

	getFormMsg (string $field)

	getPageTitle ()
	Returns the name that goes in the `<h1>` page title.Since 1.45, returning a string from this method is no longer allowed. Stability: stable to override Returns Message

	isSuppressionAllowed ()

	prepareOutputForForm ()

	showEditedWarning ()

	showEditReasonsLinks ()

	showFormWarnings ()

	showLogEntries ()
	Show deletion and creation log fragments pertaining to the current page.

	showSubpagesWarnings ()

	tempDelete ()

	usesOOUI ()
	Whether the form should use OOUI. Stability: stable to override Returns bool

Protected Member Functions inherited from MediaWiki\Actions\FormAction
	getForm ()
	Get the HTMLForm to control behavior.

	postText ()

	preText ()
	Add pre- or post-text to the form.

Protected Member Functions inherited from MediaWiki\Actions\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 ()

	setHeaders ()
	Set output headers for noindexing etc.

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

Protected Attributes
readonly LinkRenderer	$linkRenderer

readonly ReadOnlyMode	$readOnlyMode

readonly UserOptionsLookup	$userOptionsLookup

readonly 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 MediaWiki\Actions\Action
array	$fields
	The fields used to create the HTMLForm.

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\Actions\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.

Detailed Description

Handle page deletion.

Definition at line 47 of file DeleteAction.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 78 of file DeleteAction.php.

References MediaWiki\MainConfigNames\DeleteRevisionsLimit, and MediaWiki\MediaWikiServices\getInstance().

Member Function Documentation

◆ alterForm()

MediaWiki\Actions\DeleteAction::alterForm ( HTMLForm $form )

protected

Play with the HTMLForm if you need to more substantially.

Stability: stable: to override

Parameters

HTMLForm $form

Reimplemented from MediaWiki\Actions\FormAction.

Definition at line 126 of file DeleteAction.php.

References MediaWiki\Actions\DeleteAction\getFormAction(), MediaWiki\Actions\DeleteAction\getFormMsg(), MediaWiki\Actions\Action\getTitle(), and MediaWiki\HTMLForm\HTMLForm\setAction().

◆ getDefaultReason()

MediaWiki\Actions\DeleteAction::getDefaultReason ( )

protected

Default reason to be used for the deletion form.

Definition at line 637 of file DeleteAction.php.

◆ getDeleteReason()

MediaWiki\Actions\DeleteAction::getDeleteReason ( )

protected

Definition at line 562 of file DeleteAction.php.

Referenced by MediaWiki\Actions\DeleteAction\tempDelete().

◆ getFormAction()

MediaWiki\Actions\DeleteAction::getFormAction ( )

protected

Reimplemented in MediaWiki\Actions\FileDeleteAction.

Definition at line 630 of file DeleteAction.php.

Referenced by MediaWiki\Actions\DeleteAction\alterForm().

◆ getFormFields()

MediaWiki\Actions\DeleteAction::getFormFields ( )

protected

Get an HTMLForm descriptor array.

Stability: stable: to override

Returns: array

Reimplemented from MediaWiki\Actions\FormAction.

Definition at line 450 of file DeleteAction.php.

◆ getFormMessages()

MediaWiki\Actions\DeleteAction::getFormMessages ( )

protected

Returns: string[]

Reimplemented in MediaWiki\Actions\FileDeleteAction.

Definition at line 604 of file DeleteAction.php.

◆ getFormMsg()

MediaWiki\Actions\DeleteAction::getFormMsg ( string $field )

protected

Parameters

string $field One of the self::MSG_* constants

Returns: Message

Definition at line 622 of file DeleteAction.php.

Referenced by MediaWiki\Actions\DeleteAction\alterForm().

◆ getName()

MediaWiki\Actions\DeleteAction::getName ( )

Return the name of the action this object responds to.

Since: 1.17

Returns: string Lowercase name

Reimplemented from MediaWiki\Actions\Action.

Definition at line 96 of file DeleteAction.php.

◆ getPageTitle()

MediaWiki\Actions\DeleteAction::getPageTitle ( )

protected

Returns the name that goes in the <h1> page title.Since 1.45, returning a string from this method is no longer allowed.

Stability: stable: to override

Returns: Message

Reimplemented from MediaWiki\Actions\Action.

Reimplemented in MediaWiki\Actions\FileDeleteAction.

Definition at line 116 of file DeleteAction.php.

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

◆ getRestriction()

MediaWiki\Actions\DeleteAction::getRestriction ( )

Get the permission required to perform this action.Often, but not always, the same as the action nameImplementations of this methods must always return the same value, regardless of parameters passed to the constructor or system state.

Since: 1.17

Stability: stable: to override

Returns: string|null

Reimplemented from MediaWiki\Actions\Action.

Definition at line 122 of file DeleteAction.php.

◆ isSuppressionAllowed()

MediaWiki\Actions\DeleteAction::isSuppressionAllowed ( )

protected

Definition at line 446 of file DeleteAction.php.

◆ onSubmit()

MediaWiki\Actions\DeleteAction::onSubmit ( $data )

Process the form on POST submission.If you don't want to do anything with the form, just return false here.This method will be passed to the HTMLForm as a submit callback (see HTMLForm::setSubmitCallback) and must return as documented for HTMLForm::trySubmit.

See also: HTMLForm::setSubmitCallback(); HTMLForm::trySubmit()

Parameters

array $data

Returns: bool|string|array|Status Must return as documented for HTMLForm::trySubmit

Reimplemented from MediaWiki\Actions\FormAction.

Definition at line 101 of file DeleteAction.php.

◆ onSuccess()

MediaWiki\Actions\DeleteAction::onSuccess ( )

Do something exciting on successful processing of the form.This might be to show a confirmation message (watch, rollback, etc) or to redirect somewhere else (edit, protect, etc).

Reimplemented from MediaWiki\Actions\FormAction.

Definition at line 106 of file DeleteAction.php.

◆ prepareOutputForForm()

MediaWiki\Actions\DeleteAction::prepareOutputForForm ( )

protected

Definition at line 591 of file DeleteAction.php.

◆ show()

MediaWiki\Actions\DeleteAction::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.

Some actions have more exotic behavior, but that's what subclassing is for :D

Stability: stable: to override

Reimplemented from MediaWiki\Actions\FormAction.

Definition at line 137 of file DeleteAction.php.

References MediaWiki\Actions\Action\addHelpLink(), MediaWiki\Actions\Action\checkCanExecute(), MediaWiki\Actions\Action\getUser(), MediaWiki\Actions\Action\setHeaders(), MediaWiki\Actions\DeleteAction\tempDelete(), and MediaWiki\Actions\Action\useTransactionalTimeLimit().

◆ showEditedWarning()

MediaWiki\Actions\DeleteAction::showEditedWarning ( )

protected

Definition at line 303 of file DeleteAction.php.

Referenced by MediaWiki\Actions\DeleteAction\tempDelete().

◆ showEditReasonsLinks()

MediaWiki\Actions\DeleteAction::showEditReasonsLinks ( )

protected

Definition at line 424 of file DeleteAction.php.

◆ showFormWarnings()

MediaWiki\Actions\DeleteAction::showFormWarnings ( )

protected

Reimplemented in MediaWiki\Actions\FileDeleteAction.

Definition at line 346 of file DeleteAction.php.

◆ showLogEntries()

MediaWiki\Actions\DeleteAction::showLogEntries ( )

protected

Show deletion and creation log fragments pertaining to the current page.

Definition at line 580 of file DeleteAction.php.

Referenced by MediaWiki\Actions\DeleteAction\tempDelete().

◆ showSubpagesWarnings()

MediaWiki\Actions\DeleteAction::showSubpagesWarnings ( )

protected

Definition at line 363 of file DeleteAction.php.

◆ tempDelete()

MediaWiki\Actions\DeleteAction::tempDelete ( )

protected

Reimplemented in MediaWiki\Actions\FileDeleteAction.

Definition at line 148 of file DeleteAction.php.

References MediaWiki\Actions\Action\getArticle(), MediaWiki\Actions\Action\getContext(), MediaWiki\Actions\DeleteAction\getDeleteReason(), MediaWiki\Actions\Action\getRequest(), MediaWiki\Actions\Action\getTitle(), MediaWiki\Actions\Action\getWikiPage(), MediaWiki\Actions\Action\msg(), MediaWiki\Actions\DeleteAction\showEditedWarning(), MediaWiki\Actions\DeleteAction\showLogEntries(), MediaWiki\MainConfigNames\WatchlistExpiry, and wfEscapeWikiText().

Referenced by MediaWiki\Actions\DeleteAction\show().

◆ usesOOUI()

MediaWiki\Actions\DeleteAction::usesOOUI ( )

protected

Whether the form should use OOUI.

Stability: stable: to override

Returns: bool

Reimplemented from MediaWiki\Actions\FormAction.

Definition at line 111 of file DeleteAction.php.

Member Data Documentation

◆ $linkRenderer

readonly LinkRenderer MediaWiki\Actions\DeleteAction::$linkRenderer

protected

Definition at line 64 of file DeleteAction.php.

◆ $readOnlyMode

readonly ReadOnlyMode MediaWiki\Actions\DeleteAction::$readOnlyMode

protected

Definition at line 66 of file DeleteAction.php.

◆ $userOptionsLookup

readonly UserOptionsLookup MediaWiki\Actions\DeleteAction::$userOptionsLookup

protected

Definition at line 67 of file DeleteAction.php.

◆ $watchlistManager

readonly WatchlistManager MediaWiki\Actions\DeleteAction::$watchlistManager

protected

Definition at line 62 of file DeleteAction.php.

◆ MSG_COMMENT

const MediaWiki\Actions\DeleteAction::MSG_COMMENT = 'comment'

protected

Definition at line 55 of file DeleteAction.php.

◆ MSG_EDIT_REASONS

const MediaWiki\Actions\DeleteAction::MSG_EDIT_REASONS = 'edit-reasons'

protected

Definition at line 59 of file DeleteAction.php.

◆ MSG_EDIT_REASONS_SUPPRESS

const MediaWiki\Actions\DeleteAction::MSG_EDIT_REASONS_SUPPRESS = 'edit-reasons-suppress'

protected

Definition at line 60 of file DeleteAction.php.

◆ MSG_LEGEND

const MediaWiki\Actions\DeleteAction::MSG_LEGEND = 'legend'

protected

Definition at line 58 of file DeleteAction.php.

◆ MSG_REASON_DROPDOWN

const MediaWiki\Actions\DeleteAction::MSG_REASON_DROPDOWN = 'reason-dropdown'

protected

Constants used to localize form fields.

Definition at line 52 of file DeleteAction.php.

◆ MSG_REASON_DROPDOWN_OTHER

const MediaWiki\Actions\DeleteAction::MSG_REASON_DROPDOWN_OTHER = 'reason-dropdown-other'

protected

Definition at line 54 of file DeleteAction.php.

◆ MSG_REASON_DROPDOWN_SUPPRESS

const MediaWiki\Actions\DeleteAction::MSG_REASON_DROPDOWN_SUPPRESS = 'reason-dropdown-suppress'

protected

Definition at line 53 of file DeleteAction.php.

◆ MSG_REASON_OTHER

const MediaWiki\Actions\DeleteAction::MSG_REASON_OTHER = 'reason-other'

protected

Definition at line 56 of file DeleteAction.php.

◆ MSG_SUBMIT

const MediaWiki\Actions\DeleteAction::MSG_SUBMIT = 'submit'

protected

Definition at line 57 of file DeleteAction.php.

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

includes/Actions/DeleteAction.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ alterForm()

◆ getDefaultReason()

◆ getDeleteReason()

◆ getFormAction()

◆ getFormFields()

◆ getFormMessages()

◆ getFormMsg()

◆ getName()

◆ getPageTitle()

◆ getRestriction()

◆ isSuppressionAllowed()

◆ onSubmit()

◆ onSuccess()

◆ prepareOutputForForm()

◆ show()

◆ showEditedWarning()

◆ showEditReasonsLinks()

◆ showFormWarnings()

◆ showLogEntries()

◆ showSubpagesWarnings()

◆ tempDelete()

◆ usesOOUI()

Member Data Documentation

◆ $linkRenderer

◆ $readOnlyMode

◆ $userOptionsLookup

◆ $watchlistManager

◆ MSG_COMMENT

◆ MSG_EDIT_REASONS

◆ MSG_EDIT_REASONS_SUPPRESS

◆ MSG_LEGEND

◆ MSG_REASON_DROPDOWN

◆ MSG_REASON_DROPDOWN_OTHER

◆ MSG_REASON_DROPDOWN_SUPPRESS

◆ MSG_REASON_OTHER

◆ MSG_SUBMIT