MediaWiki  master
DeleteAction Class Reference

Handle page deletion. More...

Inheritance diagram for DeleteAction:
Collaboration diagram for DeleteAction:

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...
 
 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...
 
 needsReadRights ()
 Indicates whether this action requires read rights. 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. More...
 
 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. More...
 
 tempDelete ()
 
- 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...
 

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

Private Member Functions

 pageHasHistory ()
 Determines whether a page has a history of more than one revision. More...
 
 showHistoryWarnings ()
 
 tempConfirmDelete ()
 

Private Attributes

BacklinkCacheFactory $backlinkCacheFactory
 
DeletePageFactory $deletePageFactory
 
int $deleteRevisionsLimit
 

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

Detailed Description

Handle page deletion.

Definition at line 36 of file DeleteAction.php.

Constructor & Destructor Documentation

◆ __construct()

DeleteAction::__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 Action.

Reimplemented in MediaWiki\Actions\FileDeleteAction.

Definition at line 75 of file DeleteAction.php.

References Action\$context, and Action\$page.

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 565 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 528 of file DeleteAction.php.

References Action\getArticle(), Action\getRequest(), and MWExceptionHandler\logException().

Referenced by tempConfirmDelete().

◆ getDeleteReason()

DeleteAction::getDeleteReason ( )
protected
Returns
string

Definition at line 445 of file DeleteAction.php.

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

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

◆ getFormAction()

DeleteAction::getFormAction ( )
protected
Returns
string

Reimplemented in MediaWiki\Actions\FileDeleteAction.

Definition at line 519 of file DeleteAction.php.

References Action\getTitle().

Referenced by showForm().

◆ getFormMessages()

DeleteAction::getFormMessages ( )
protected
Returns
string[]

Reimplemented in MediaWiki\Actions\FileDeleteAction.

Definition at line 490 of file DeleteAction.php.

Referenced by getFormMsg().

◆ getFormMsg()

DeleteAction::getFormMsg ( string  $field)
protected
Parameters
string$fieldOne of the self::MSG_* constants
Returns
Message

Definition at line 508 of file DeleteAction.php.

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

Referenced by showEditReasonsLinks(), and showForm().

◆ 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 87 of file DeleteAction.php.

◆ isSuppressionAllowed()

DeleteAction::isSuppressionAllowed ( )
protected
Returns
bool

Definition at line 289 of file DeleteAction.php.

References Action\getContext().

Referenced by showEditReasonsLinks(), and showForm().

◆ 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 91 of file DeleteAction.php.

◆ pageHasHistory()

DeleteAction::pageHasHistory ( )
private

Determines whether a page has a history of more than one revision.

@fixme We should use WikiPage::isNew() here, but it doesn't work right for undeleted pages (T289008)

Returns
bool

Definition at line 550 of file DeleteAction.php.

References $dbr, $res, DB_REPLICA, Action\getTitle(), and wfGetDB().

Referenced by tempConfirmDelete().

◆ prepareOutput()

DeleteAction::prepareOutput ( Message  $pageTitle)
protected
Parameters
Message$pageTitle

Definition at line 473 of file DeleteAction.php.

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

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

◆ prepareOutputForForm()

DeleteAction::prepareOutputForForm ( )
protected

◆ runExecuteChecks()

DeleteAction::runExecuteChecks ( )
protected
Todo:
Should use Action::checkCanExecute instead

Reimplemented in MediaWiki\Actions\FileDeleteAction.

Definition at line 431 of file DeleteAction.php.

References getAuthority(), Action\getContext(), and Action\getTitle().

Referenced by tempDelete().

◆ show()

DeleteAction::show ( )
Stability: stable
to override

Reimplemented from FormlessAction.

Definition at line 95 of file DeleteAction.php.

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

◆ showEditReasonsLinks()

◆ showForm()

◆ showFormWarnings()

DeleteAction::showFormWarnings ( )
protected

◆ showHistoryWarnings()

◆ showLogEntries()

DeleteAction::showLogEntries ( )
protected

Show deletion log fragments pertaining to the current page.

Definition at line 463 of file DeleteAction.php.

References Xml\element(), Action\getContext(), Action\getTitle(), and LogEventsList\showLogExtract().

Referenced by MediaWiki\Actions\FileDeleteAction\showConfirm(), tempConfirmDelete(), and tempDelete().

◆ tempConfirmDelete()

◆ tempDelete()

Member Data Documentation

◆ $backlinkCacheFactory

BacklinkCacheFactory DeleteAction::$backlinkCacheFactory
private

Definition at line 58 of file DeleteAction.php.

◆ $deletePageFactory

DeletePageFactory DeleteAction::$deletePageFactory
private

Definition at line 67 of file DeleteAction.php.

◆ $deleteRevisionsLimit

int DeleteAction::$deleteRevisionsLimit
private

Definition at line 70 of file DeleteAction.php.

◆ $linkRenderer

LinkRenderer DeleteAction::$linkRenderer
protected

Definition at line 55 of file DeleteAction.php.

◆ $readOnlyMode

ReadOnlyMode DeleteAction::$readOnlyMode
protected

Definition at line 61 of file DeleteAction.php.

◆ $userOptionsLookup

UserOptionsLookup DeleteAction::$userOptionsLookup
protected

Definition at line 64 of file DeleteAction.php.

◆ $watchlistManager

WatchlistManager DeleteAction::$watchlistManager
protected

Definition at line 52 of file DeleteAction.php.

◆ MSG_COMMENT

const DeleteAction::MSG_COMMENT = 'comment'
protected

Definition at line 44 of file DeleteAction.php.

◆ MSG_EDIT_REASONS

const DeleteAction::MSG_EDIT_REASONS = 'edit-reasons'
protected

Definition at line 48 of file DeleteAction.php.

◆ MSG_EDIT_REASONS_SUPPRESS

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

Definition at line 49 of file DeleteAction.php.

◆ MSG_LEGEND

const DeleteAction::MSG_LEGEND = 'legend'
protected

Definition at line 47 of file DeleteAction.php.

◆ MSG_REASON_DROPDOWN

const DeleteAction::MSG_REASON_DROPDOWN = 'reason-dropdown'
protected

Constants used to localize form fields.

Definition at line 41 of file DeleteAction.php.

◆ MSG_REASON_DROPDOWN_OTHER

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

Definition at line 43 of file DeleteAction.php.

◆ MSG_REASON_DROPDOWN_SUPPRESS

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

Definition at line 42 of file DeleteAction.php.

◆ MSG_REASON_OTHER

const DeleteAction::MSG_REASON_OTHER = 'reason-other'
protected

Definition at line 45 of file DeleteAction.php.

◆ MSG_SUBMIT

const DeleteAction::MSG_SUBMIT = 'submit'
protected

Definition at line 46 of file DeleteAction.php.


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