MediaWiki 1.42.1
|
Actions are things which can be done to pages (edit, delete, rollback, etc). More...
Inherits MessageLocalizer.
Inherited by FormAction, and FormlessAction.
Public Member Functions | |
__construct (Article $article, IContextSource $context) | |
Only public since 1.21. | |
addHelpLink ( $to, $overrideBaseUrl=false) | |
Adds help link with an icon via page indicators. | |
doesWrites () | |
Indicates whether this action may perform database writes. | |
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. | |
getName () | |
Return the name of the action this object responds to. | |
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) | |
show () | |
The main action entry point. | |
Static Public Member Functions | |
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 Member Functions | |
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 | |
IContextSource null | $context |
IContextSource if specified; otherwise we'll use the Context from the Page. | |
array | $fields |
The fields used to create the HTMLForm. | |
Actions are things which can be done to pages (edit, delete, rollback, etc).
They are distinct from Special Pages because an action must apply to exactly one page.
To add an action in an extension, create a subclass of Action, and add the key to $wgActions.
Actions generally fall into two groups: the show-a-form-then-do-something-with-the-input format (protect, delete, move, etc), and the just-do-something format (watch, rollback, patrol, etc). The FormAction and FormlessAction classes represent these two groups.
Definition at line 51 of file Action.php.
Action::__construct | ( | Article | $article, |
IContextSource | $context ) |
Only public since 1.21.
Article | $article | |
IContextSource | $context |
Reimplemented in DeleteAction, and MediaWiki\Actions\FileDeleteAction.
Definition at line 270 of file Action.php.
Action::addHelpLink | ( | $to, | |
$overrideBaseUrl = false ) |
Adds help link with an icon via page indicators.
Link target can be overridden by a local message containing a wikilink: the message key is: lowercase action name + '-helppage'.
string | $to | Target MediaWiki.org page title or encoded URL. |
bool | $overrideBaseUrl | Whether $url is a full URL, to avoid MW.o. |
Definition at line 442 of file Action.php.
Referenced by HistoryAction\onView(), InfoAction\onView(), and DeleteAction\show().
|
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
User | $user |
UserBlockedError|ReadOnlyError|PermissionsError |
Reimplemented in MediaWiki\Actions\FileDeleteAction, McrUndoAction, RevertAction, and WatchAction.
Definition at line 323 of file Action.php.
References MediaWiki\User\User\getBlock(), getRequest(), and getTitle().
Referenced by DeleteAction\show(), FormAction\show(), FormlessAction\show(), PurgeAction\show(), and RollbackAction\show().
Action::doesWrites | ( | ) |
Indicates whether this action may perform database writes.
Reimplemented in EditAction, FormAction, MarkpatrolledAction, ProtectAction, PurgeAction, RevertAction, RollbackAction, UnprotectAction, UnwatchAction, and WatchAction.
Definition at line 483 of file Action.php.
|
staticfinal |
Get an appropriate Action subclass for the given action.
string | $action | |
Article | $article | |
IContextSource | null | $context | Falls back to article's context |
Definition at line 88 of file Action.php.
References $context, and Article\getContext().
|
staticfinal |
Get the action that will be executed, not necessarily the one passed passed through the "action" request parameter.
Actions disabled in $wgActions will be replaced by "nosuchaction".
IContextSource | $context |
Definition at line 107 of file Action.php.
References MediaWiki\Context\IContextSource\getActionName().
Action::getArticle | ( | ) |
Get a Article object.
Definition at line 201 of file Action.php.
Referenced by MediaWiki\Actions\FileDeleteAction\__construct(), getContext(), FormAction\getForm(), HistoryAction\onView(), InfoAction\onView(), EditAction\show(), ProtectAction\show(), RenderAction\show(), UnprotectAction\show(), ViewAction\show(), and DeleteAction\tempDelete().
|
final |
Shortcut to get the Authority executing this instance.
Definition at line 161 of file Action.php.
Referenced by PurgeAction\onSubmit().
|
final |
Get the IContextSource in use here.
Definition at line 117 of file Action.php.
References getArticle(), and wfDebug().
Referenced by FormAction\getForm().
|
protected |
Returns the description that goes below the <h1>
element.
Reimplemented in CreditsAction, HistoryAction, InfoAction, MarkpatrolledAction, McrRestoreAction, McrUndoAction, PurgeAction, RevertAction, RollbackAction, and WatchAction.
Definition at line 430 of file Action.php.
|
protected |
Definition at line 242 of file Action.php.
|
protected |
Definition at line 255 of file Action.php.
Referenced by HistoryAction\getDescription(), FormAction\getForm(), McrUndoAction\onSubmit(), HistoryAction\onView(), InfoAction\onView(), RawAction\onView(), and EditAction\show().
|
final |
Shortcut to get the user Language being used for this instance.
Definition at line 180 of file Action.php.
References getContext().
Referenced by CreditsAction\getContributors(), HistoryAction\getDescription(), RevertAction\getFormFields(), and RevertAction\onSuccess().
|
abstract |
Return the name of the action this object responds to.
Reimplemented in CreditsAction, DeleteAction, EditAction, HistoryAction, InfoAction, MarkpatrolledAction, McrRestoreAction, McrUndoAction, ProtectAction, PurgeAction, RawAction, RenderAction, RevertAction, RollbackAction, SubmitAction, UnprotectAction, UnwatchAction, ViewAction, and WatchAction.
Referenced by FormAction\getForm().
|
final |
Get the OutputPage being used for this instance.
Definition at line 141 of file Action.php.
References getContext().
Referenced by RollbackAction\handleRollbackRequest(), MarkpatrolledAction\onSubmit(), McrUndoAction\onSuccess(), PurgeAction\onSuccess(), RevertAction\onSuccess(), UnwatchAction\onSuccess(), CreditsAction\onView(), HistoryAction\onView(), InfoAction\onView(), RawAction\onView(), EditAction\show(), FormlessAction\show(), McrUndoAction\show(), PurgeAction\show(), and ViewAction\show().
|
protected |
Returns the name that goes in the <h1>
page title.
Since 1.41, returning a string from this method has been deprecated.
Reimplemented in DeleteAction, MediaWiki\Actions\FileDeleteAction, HistoryAction, InfoAction, and RevertAction.
Definition at line 419 of file Action.php.
References getTitle().
|
final |
Get the WebRequest being used for this instance.
Definition at line 131 of file Action.php.
References getContext().
Referenced by MediaWiki\Actions\FileDeleteAction\__construct(), FormAction\getForm(), and PurgeAction\show().
Action::getRestriction | ( | ) |
Get the permission required to perform this action.
Often, but not always, the same as the action name
Implementations of this methods must always return the same value, regardless of parameters passed to the constructor or system state.
Reimplemented in DeleteAction, MarkpatrolledAction, McrUndoAction, RevertAction, RollbackAction, and WatchAction.
Definition at line 295 of file Action.php.
|
final |
Shortcut to get the Skin being used for this instance.
Definition at line 171 of file Action.php.
References getContext().
|
final |
Shortcut to get the Title object from the page.
Definition at line 211 of file Action.php.
Referenced by MediaWiki\Actions\FileDeleteAction\__construct(), FormAction\getForm(), MediaWiki\Actions\FileDeleteAction\getPageTitle(), PurgeAction\onSuccess(), and EditAction\show().
|
final |
Shortcut to get the User being used for this instance.
Definition at line 151 of file Action.php.
References getContext().
Referenced by EditAction\show(), FormAction\show(), FormlessAction\show(), and PurgeAction\show().
|
final |
Get a WikiPage object.
Definition at line 190 of file Action.php.
Referenced by CreditsAction\getContributors(), RawAction\getOldId(), RollbackAction\handleRollbackRequest(), McrRestoreAction\initFromParameters(), McrUndoAction\initFromParameters(), McrUndoAction\onSubmit(), PurgeAction\onSubmit(), CreditsAction\onView(), HistoryAction\onView(), RawAction\onView(), ViewAction\show(), and DeleteAction\tempDelete().
|
final |
Get a Message object with context set Parameters are the same as wfMessage()
string | string[] | MessageSpecifier | $key | |
mixed | ...$params |
Implements MessageLocalizer.
Definition at line 223 of file Action.php.
References $params, and getContext().
Referenced by RevertAction\checkCanExecute(), CreditsAction\getContributors(), CreditsAction\getDescription(), HistoryAction\getDescription(), PurgeAction\getFormFields(), RevertAction\getFormFields(), RollbackAction\getFormFields(), UnwatchAction\getFormFields(), WatchAction\getFormFields(), DeleteAction\getPageTitle(), MediaWiki\Actions\FileDeleteAction\getPageTitle(), HistoryAction\getPageTitle(), RevertAction\getPageTitle(), RollbackAction\handleRollbackRequest(), MarkpatrolledAction\onSubmit(), CreditsAction\onView(), HistoryAction\onView(), InfoAction\onView(), CreditsAction\othersLink(), PurgeAction\postText(), MarkpatrolledAction\preText(), DeleteAction\tempDelete(), and CreditsAction\userLink().
Action::needsReadRights | ( | ) |
Indicates whether this action requires read rights.
Implementations of this methods must always return the same value, regardless of parameters passed to the constructor or system state.
Reimplemented in ViewAction.
Definition at line 309 of file Action.php.
Action::requiresUnblock | ( | ) |
Whether this action can still be executed by a blocked user.
Implementations of this methods must always return the same value, regardless of parameters passed to the constructor or system state.
Reimplemented in HistoryAction, InfoAction, RawAction, and WatchAction.
Definition at line 387 of file Action.php.
Action::requiresWrite | ( | ) |
Whether this action requires the wiki not to be locked.
Implementations of this methods must always return the same value, regardless of parameters passed to the constructor or system state.
Reimplemented in HistoryAction, InfoAction, and RawAction.
Definition at line 372 of file Action.php.
|
protected |
Set output headers for noindexing etc.
This function will not be called through the execute() entry point, so only put UI-related stuff in here.
Definition at line 397 of file Action.php.
References wfDeprecated().
Referenced by DeleteAction\show(), FormAction\show(), FormlessAction\show(), PurgeAction\show(), and RollbackAction\show().
Action::setHookContainer | ( | HookContainer | $hookContainer | ) |
HookContainer | $hookContainer |
Definition at line 232 of file Action.php.
|
abstract |
The main action entry point.
Do all output for display and send it to the context output. Do not use globals $wgOut, $wgRequest, etc, in implementations; use $this->getOutput(), etc.
ErrorPageError |
Reimplemented in DeleteAction, EditAction, FormAction, FormlessAction, McrUndoAction, ProtectAction, PurgeAction, RenderAction, RollbackAction, SubmitAction, UnprotectAction, and ViewAction.
|
protected |
Call wfTransactionalTimeLimit() if this request was POSTed.
Definition at line 471 of file Action.php.
References getRequest(), and wfTransactionalTimeLimit().
Referenced by RevertAction\onSubmit(), DeleteAction\show(), EditAction\show(), and McrUndoAction\show().
|
protected |
IContextSource if specified; otherwise we'll use the Context from the Page.
Definition at line 64 of file Action.php.
Referenced by MediaWiki\Actions\FileDeleteAction\__construct(), factory(), and DeleteAction\tempDelete().
|
protected |
The fields used to create the HTMLForm.
Definition at line 71 of file Action.php.
Referenced by HistoryAction\onView().