Handle page deletion. More...

Inherits FormlessAction.

Inherited by MediaWiki\Actions\FileDeleteAction.

Collaboration diagram for DeleteAction:

[legend]

Public Member Functions

__construct (Article $article, IContextSource $context)

Only public since 1.21.

Stability: stable: to call

Parameters

Article	$article
IContextSource	$context

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.

setHookContainer (HookContainer $hookContainer)

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

	getDeleteReason ()

	getFormAction ()

	getFormMessages ()

	getFormMsg (string $field)

	isSuppressionAllowed ()

	prepareOutput (Message $pageTitle)

	prepareOutputForForm ()

	runExecuteChecks ()

	showEditReasonsLinks ()

	showForm (string $reason)

	showFormWarnings ()

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

	showSubpagesWarnings ()

	tempDelete ()

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.

Protected Attributes
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.

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.

Detailed Description

Handle page deletion.

Definition at line 41 of file DeleteAction.php.

Constructor & Destructor Documentation

◆ __construct()

DeleteAction::__construct	(	Article	$article,
		IContextSource	$context )

Only public since 1.21.

Stability: stable: to call

Parameters

Article	$article
IContextSource	$context

Reimplemented from Action.

Reimplemented in MediaWiki\Actions\FileDeleteAction.

Definition at line 89 of file DeleteAction.php.

Member Function Documentation

◆ doesWrites()

DeleteAction::doesWrites ( )

Indicates whether this action may perform database writes.

Returns: bool

Since: 1.27

Stability: stable: to override

Reimplemented from Action.

Definition at line 677 of file DeleteAction.php.

◆ getDefaultReason()

DeleteAction::getDefaultReason ( )

protected

Default reason to be used for the deletion form.

Returns: string

Reimplemented in MediaWiki\Actions\FileDeleteAction.

Definition at line 637 of file DeleteAction.php.

◆ getDeleteReason()

DeleteAction::getDeleteReason ( )

protected

Returns: string

Definition at line 554 of file DeleteAction.php.

Referenced by tempDelete().

◆ getFormAction()

DeleteAction::getFormAction ( )

protected

Returns: string

Reimplemented in MediaWiki\Actions\FileDeleteAction.

Definition at line 628 of file DeleteAction.php.

◆ getFormMessages()

DeleteAction::getFormMessages ( )

protected

Returns: string[]

Reimplemented in MediaWiki\Actions\FileDeleteAction.

Definition at line 599 of file DeleteAction.php.

◆ getFormMsg()

DeleteAction::getFormMsg ( string $field )

protected

Parameters

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

Returns: Message

Definition at line 617 of file DeleteAction.php.

◆ getName()

DeleteAction::getName ( )

Return the name of the action this object responds to.

Since: 1.17

Returns: string Lowercase name

Reimplemented from Action.

Definition at line 104 of file DeleteAction.php.

◆ isSuppressionAllowed()

DeleteAction::isSuppressionAllowed ( )

protected

Returns: bool

Definition at line 381 of file DeleteAction.php.

◆ onView()

DeleteAction::onView ( )

Show something on GET request.

Returns: string|null Will be added to the HTMLForm if present, or just added to the output if not. Return null to not add anything

Reimplemented from FormlessAction.

Definition at line 108 of file DeleteAction.php.

◆ prepareOutput()

DeleteAction::prepareOutput ( Message $pageTitle )

protected

Parameters

Message $pageTitle

Definition at line 582 of file DeleteAction.php.

Referenced by tempDelete().

◆ prepareOutputForForm()

DeleteAction::prepareOutputForForm ( )

protected

Definition at line 589 of file DeleteAction.php.

◆ runExecuteChecks()

DeleteAction::runExecuteChecks ( )

protected

Todo: Should use Action::checkCanExecute instead

Reimplemented in MediaWiki\Actions\FileDeleteAction.

Definition at line 540 of file DeleteAction.php.

Referenced by tempDelete().

◆ show()

DeleteAction::show ( )

Stability: stable: to override

Reimplemented from FormlessAction.

Definition at line 112 of file DeleteAction.php.

References Action\addHelpLink(), tempDelete(), and Action\useTransactionalTimeLimit().

◆ showEditReasonsLinks()

DeleteAction::showEditReasonsLinks ( )

protected

Definition at line 356 of file DeleteAction.php.

References getTitle().

◆ showForm()

DeleteAction::showForm ( string $reason )

protected

Parameters

string $reason

Definition at line 388 of file DeleteAction.php.

◆ showFormWarnings()

DeleteAction::showFormWarnings ( )

protected

Reimplemented in MediaWiki\Actions\FileDeleteAction.

Definition at line 290 of file DeleteAction.php.

◆ showLogEntries()

DeleteAction::showLogEntries ( )

protected

Show deletion log fragments pertaining to the current page.

Definition at line 572 of file DeleteAction.php.

Referenced by tempDelete().

◆ showSubpagesWarnings()

DeleteAction::showSubpagesWarnings ( )

protected

Definition at line 307 of file DeleteAction.php.

◆ tempDelete()

DeleteAction::tempDelete ( )

protected

Reimplemented in MediaWiki\Actions\FileDeleteAction.

Definition at line 118 of file DeleteAction.php.

References Action\$context, $title, Action\getArticle(), IContextSource\getAuthority(), getContext(), getDeleteReason(), IContextSource\getLanguage(), IContextSource\getOutput(), IContextSource\getRequest(), getTitle(), IContextSource\getUser(), Action\getWikiPage(), Action\msg(), MessageLocalizer\msg(), prepareOutput(), runExecuteChecks(), showLogEntries(), and wfEscapeWikiText().

Referenced by show().

Member Data Documentation

◆ $linkRenderer

LinkRenderer DeleteAction::$linkRenderer

protected

Definition at line 60 of file DeleteAction.php.

◆ $readOnlyMode

ReadOnlyMode DeleteAction::$readOnlyMode

protected

Definition at line 66 of file DeleteAction.php.

◆ $userOptionsLookup

UserOptionsLookup DeleteAction::$userOptionsLookup

protected

Definition at line 69 of file DeleteAction.php.

◆ $watchlistManager

WatchlistManager DeleteAction::$watchlistManager

protected

Definition at line 57 of file DeleteAction.php.

◆ MSG_COMMENT

const DeleteAction::MSG_COMMENT = 'comment'

protected

Definition at line 49 of file DeleteAction.php.

◆ MSG_EDIT_REASONS

const DeleteAction::MSG_EDIT_REASONS = 'edit-reasons'

protected

Definition at line 53 of file DeleteAction.php.

◆ MSG_EDIT_REASONS_SUPPRESS

const DeleteAction::MSG_EDIT_REASONS_SUPPRESS = 'edit-reasons-suppress'

protected

Definition at line 54 of file DeleteAction.php.

◆ MSG_LEGEND

const DeleteAction::MSG_LEGEND = 'legend'

protected

Definition at line 52 of file DeleteAction.php.

◆ MSG_REASON_DROPDOWN

const DeleteAction::MSG_REASON_DROPDOWN = 'reason-dropdown'

protected

Constants used to localize form fields.

Definition at line 46 of file DeleteAction.php.

◆ MSG_REASON_DROPDOWN_OTHER

const DeleteAction::MSG_REASON_DROPDOWN_OTHER = 'reason-dropdown-other'

protected

Definition at line 48 of file DeleteAction.php.

◆ MSG_REASON_DROPDOWN_SUPPRESS

const DeleteAction::MSG_REASON_DROPDOWN_SUPPRESS = 'reason-dropdown-suppress'

protected

Definition at line 47 of file DeleteAction.php.

◆ MSG_REASON_OTHER

const DeleteAction::MSG_REASON_OTHER = 'reason-other'

protected

Definition at line 50 of file DeleteAction.php.

◆ MSG_SUBMIT

const DeleteAction::MSG_SUBMIT = 'submit'

protected

Definition at line 51 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

◆ doesWrites()

◆ getDefaultReason()

◆ getDeleteReason()

◆ getFormAction()

◆ getFormMessages()

◆ getFormMsg()

◆ getName()

◆ isSuppressionAllowed()

◆ onView()

◆ prepareOutput()

◆ prepareOutputForForm()

◆ runExecuteChecks()

◆ show()

◆ showEditReasonsLinks()

◆ showForm()

◆ showFormWarnings()

◆ showLogEntries()

◆ showSubpagesWarnings()

◆ tempDelete()

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