MediaWiki REL1_28
|
Page addition to a user's watchlist. More...
Public Member Functions | |
doesWrites () | |
Indicates whether this action may perform database writes. | |
getName () | |
Return the name of the action this object responds to. | |
onSubmit ( $data) | |
Process the form on POST submission. | |
onSuccess () | |
Do something exciting on successful processing of the form. | |
requiresUnblock () | |
Whether this action can still be executed by a blocked user. | |
Public Member Functions inherited from FormAction | |
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 Action | |
__construct (Page $page, IContextSource $context=null) | |
Constructor. | |
addHelpLink ( $to, $overrideBaseUrl=false) | |
Adds help link with an icon via page indicators. | |
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. | |
msg () | |
Get a Message object with context set Parameters are the same as wfMessage() | |
requiresWrite () | |
Whether this action requires the wiki not to be locked. | |
Static Public Member Functions | |
static | doUnwatch (Title $title, User $user) |
Unwatch a page. | |
static | doWatch (Title $title, User $user, $checkRights=User::CHECK_USER_RIGHTS) |
Watch a page. | |
static | doWatchOrUnwatch ( $watch, Title $title, User $user) |
Watch or unwatch a page. | |
static | getUnwatchToken (Title $title, User $user, $action='unwatch') |
Get token to unwatch (or watch) a page for a user. | |
static | getWatchToken (Title $title, User $user, $action='watch') |
Get token to watch (or unwatch) a page for a user. | |
Static Public Member Functions inherited from Action | |
static | exists ( $name) |
Check if a given action is recognised, even if it's disabled. | |
static | factory ( $action, Page $page, 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 | |
alterForm (HTMLForm $form) | |
Play with the HTMLForm if you need to more substantially. | |
checkCanExecute (User $user) | |
Checks if the given user (identified by an object) can perform this action. | |
getDescription () | |
preText () | |
Add pre- or post-text to the form. | |
Protected Member Functions inherited from FormAction | |
getForm () | |
Get the HTMLForm to control behavior. | |
getFormFields () | |
Get an HTMLForm descriptor array. | |
postText () | |
Protected Member Functions inherited from Action | |
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 | |
Protected Attributes inherited from Action | |
$context | |
IContextSource if specified; otherwise we'll use the Context from the Page. | |
$fields | |
The fields used to create the HTMLForm. | |
$page | |
Page on which we're performing the action. | |
Page addition to a user's watchlist.
Definition at line 28 of file WatchAction.php.
|
protected |
Play with the HTMLForm if you need to more substantially.
HTMLForm | $form |
Reimplemented from FormAction.
Reimplemented in UnwatchAction.
Definition at line 60 of file WatchAction.php.
References HTMLForm\setSubmitTextMsg(), and HTMLForm\setTokenSalt().
|
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 | The user to check, or null to use the context user |
UserBlockedError|ReadOnlyError|PermissionsError |
Reimplemented from Action.
Definition at line 51 of file WatchAction.php.
References $user.
WatchAction::doesWrites | ( | ) |
Indicates whether this action may perform database writes.
Reimplemented from FormAction.
Reimplemented in UnwatchAction.
Definition at line 184 of file WatchAction.php.
Unwatch a page.
Definition at line 137 of file WatchAction.php.
References Action\$page, $status, $title, $user, and WikiPage\factory().
Referenced by doWatchOrUnwatch(), UnwatchAction\onSubmit(), and ApiWatch\watchTitle().
|
static |
Watch a page.
Title | $title | Page to watch/unwatch |
User | $user | User who is watching/unwatching |
bool | $checkRights | Passed through to $user->addWatch() Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS. |
Definition at line 109 of file WatchAction.php.
References Action\$page, $status, $title, $user, and WikiPage\factory().
Referenced by doWatchOrUnwatch(), onSubmit(), UploadBase\performUpload(), SpecialBlock\processForm(), and ApiWatch\watchTitle().
Watch or unwatch a page.
bool | $watch | Whether to watch or unwatch the page |
Title | $title | Page to watch/unwatch |
User | $user | User who is watching/unwatching |
Definition at line 84 of file WatchAction.php.
References $title, $user, doUnwatch(), and doWatch().
Referenced by Article\delete(), MovePageForm\doSubmit(), FileDeleteForm\execute(), ProtectionForm\save(), ApiBase\setWatch(), and EditPage\updateWatchlist().
|
protected |
Reimplemented from Action.
Reimplemented in UnwatchAction.
Definition at line 41 of file WatchAction.php.
References Action\msg().
WatchAction::getName | ( | ) |
Return the name of the action this object responds to.
Reimplemented from Action.
Reimplemented in UnwatchAction.
Definition at line 30 of file WatchAction.php.
Get token to unwatch (or watch) a page for a user.
Title | $title | Title object of page to unwatch |
User | $user | User for whom the action is going to be performed |
string | $action | Optionally override the action to 'watch' |
Definition at line 180 of file WatchAction.php.
References $title, $user, and getWatchToken().
Get token to watch (or unwatch) a page for a user.
Title | $title | Title object of page to watch |
User | $user | User for whom the action is going to be performed |
string | $action | Optionally override the action to 'unwatch' |
Definition at line 163 of file WatchAction.php.
References $user.
Referenced by getUnwatchToken().
WatchAction::onSubmit | ( | $data | ) |
Process the form on POST submission.
If you don't want to do anything with the form, just return false here.
array | $data |
Reimplemented from FormAction.
Reimplemented in UnwatchAction.
Definition at line 45 of file WatchAction.php.
References doWatch(), Action\getTitle(), and Action\getUser().
WatchAction::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 FormAction.
Reimplemented in UnwatchAction.
Definition at line 69 of file WatchAction.php.
References Action\getOutput(), and Action\getTitle().
|
protected |
Add pre- or post-text to the form.
Reimplemented from FormAction.
Reimplemented in UnwatchAction.
Definition at line 65 of file WatchAction.php.
References Action\msg().
WatchAction::requiresUnblock | ( | ) |
Whether this action can still be executed by a blocked user.
Reimplemented from Action.
Definition at line 34 of file WatchAction.php.