MediaWiki master
MarkpatrolledAction Class Reference

Mark a revision as patrolled on a page. More...

Inherits FormAction.

Collaboration diagram for MarkpatrolledAction:

Public Member Functions

 __construct (Article $article, IContextSource $context, LinkRenderer $linkRenderer)
 
 doesWrites ()
 
 getName ()
 Return the name of the action this object responds to.
 
 getRestriction ()
 Get the permission required to perform this action.
 
 onSubmit ( $data)
 
 onSuccess ()
 Do something exciting on successful processing of the form.
 
- 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 (Article $article, 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 ()
 Whether this action requires the wiki not to be locked.
 
 setHookContainer (HookContainer $hookContainer)
 

Protected Member Functions

 alterForm (HTMLForm $form)
 Play with the HTMLForm if you need to more substantially.
 
 getDescription ()
 Returns the description that goes below the <h1> element.
 
 getRecentChange ( $data=null)
 
 preText ()
 Add pre- or post-text to the form.
 
 usesOOUI ()
 Whether the form should use OOUI.
 
- 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
 checkCanExecute (User $user)
 Checks if the given user (identified by an object) can perform this action.
 
 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.
 

Additional Inherited Members

- Static Public Member Functions inherited from 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.
 
- 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.
 

Detailed Description

Mark a revision as patrolled on a page.

Definition at line 33 of file MarkpatrolledAction.php.

Constructor & Destructor Documentation

◆ __construct()

MarkpatrolledAction::__construct ( Article  $article,
IContextSource  $context,
LinkRenderer  $linkRenderer 
)
Parameters
Article$article
IContextSource$context
LinkRenderer$linkRenderer

Definition at line 42 of file MarkpatrolledAction.php.

Member Function Documentation

◆ alterForm()

MarkpatrolledAction::alterForm ( HTMLForm  $form)
protected

Play with the HTMLForm if you need to more substantially.

Stability: stable
to override
Parameters
HTMLForm$form

Reimplemented from FormAction.

Definition at line 103 of file MarkpatrolledAction.php.

References getRequest().

◆ doesWrites()

MarkpatrolledAction::doesWrites ( )
Stability: stable
to override
Returns
bool

Reimplemented from FormAction.

Definition at line 157 of file MarkpatrolledAction.php.

◆ getDescription()

MarkpatrolledAction::getDescription ( )
protected

Returns the description that goes below the <h1> element.

Since
1.17
Stability: stable
to override
Returns
string HTML

Reimplemented from Action.

Definition at line 55 of file MarkpatrolledAction.php.

◆ getName()

MarkpatrolledAction::getName ( )

Return the name of the action this object responds to.

Since
1.17
Returns
string Lowercase name

Reimplemented from Action.

Definition at line 51 of file MarkpatrolledAction.php.

◆ getRecentChange()

MarkpatrolledAction::getRecentChange (   $data = null)
protected

Definition at line 68 of file MarkpatrolledAction.php.

References getRequest().

Referenced by onSubmit(), and preText().

◆ getRestriction()

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

Since
1.17
Stability: stable
to override
Returns
string|null

Reimplemented from Action.

Definition at line 60 of file MarkpatrolledAction.php.

◆ onSubmit()

MarkpatrolledAction::onSubmit (   $data)
Parameters
array$data
Returns
bool|array True for success, false for didn't-try, array of errors on failure

Reimplemented from FormAction.

Definition at line 113 of file MarkpatrolledAction.php.

References getAuthority(), Action\getOutput(), getRecentChange(), Action\msg(), and RC_NEW.

◆ onSuccess()

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

Definition at line 153 of file MarkpatrolledAction.php.

◆ preText()

MarkpatrolledAction::preText ( )
protected

Add pre- or post-text to the form.

Stability: stable
to override
Returns
string HTML which will be sent to $form->addPreText()

Reimplemented from FormAction.

Definition at line 81 of file MarkpatrolledAction.php.

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

◆ usesOOUI()

MarkpatrolledAction::usesOOUI ( )
protected

Whether the form should use OOUI.

Stability: stable
to override
Returns
bool

Reimplemented from FormAction.

Definition at line 64 of file MarkpatrolledAction.php.


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