MediaWiki  master
MarkpatrolledAction Class Reference

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

Inheritance diagram for MarkpatrolledAction:
Collaboration diagram for MarkpatrolledAction:

Public Member Functions

 doesWrites ()
 getName ()
 getRestriction ()
 onSubmit ( $data)
 onSuccess ()
- Public Member Functions inherited from FormAction
 doesWrites ()
 onSubmit ( $data)
 Process the form on POST submission. More...
 onSuccess ()
 Do something exciting on successful processing of the form. More...
 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. More...
- Public Member Functions inherited from Action
 __construct (Page $page, IContextSource $context=null)
 Only public since 1.21. More...
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 doesWrites ()
 Indicates whether this action may perform database writes. More...
 getContext ()
 Get the IContextSource in use here. More...
 getLanguage ()
 Shortcut to get the user Language being used for this instance. More...
 getName ()
 Return the name of the action this object responds to. 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...
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage() 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...
 show ()
 The main action entry point. More...

Protected Member Functions

 alterForm (HTMLForm $form)
 getDescription ()
 getRecentChange ( $data=null)
 preText ()
 usesOOUI ()
- Protected Member Functions inherited from FormAction
 alterForm (HTMLForm $form)
 Play with the HTMLForm if you need to more substantially. More...
 getForm ()
 Get the HTMLForm to control behavior. More...
 getFormFields ()
 Get an HTMLForm descriptor array. More...
 postText ()
 preText ()
 Add pre- or post-text to the form. More...
 usesOOUI ()
 Whether the form should use OOUI. More...
- 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...
 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...

Additional Inherited Members

- Static Public Member Functions inherited from Action
static exists ( $name)
 Check if a given action is recognised, even if it's disabled. More...
static factory ( $action, Page $page, 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...
- Protected Attributes inherited from Action
 IContextSource if specified; otherwise we'll use the Context from the Page. More...
 The fields used to create the HTMLForm. More...
 Page on which we're performing the action. More...

Detailed Description

Mark a revision as patrolled on a page.

Definition at line 30 of file MarkpatrolledAction.php.

Member Function Documentation

◆ alterForm()

MarkpatrolledAction::alterForm ( HTMLForm  $form)

◆ doesWrites()

MarkpatrolledAction::doesWrites ( )

Definition at line 140 of file MarkpatrolledAction.php.

◆ getDescription()

MarkpatrolledAction::getDescription ( )

Definition at line 36 of file MarkpatrolledAction.php.

◆ getName()

MarkpatrolledAction::getName ( )

Definition at line 32 of file MarkpatrolledAction.php.

◆ getRecentChange()

MarkpatrolledAction::getRecentChange (   $data = null)

Definition at line 49 of file MarkpatrolledAction.php.

References Action\getRequest(), and RecentChange\newFromId().

Referenced by onSubmit(), and preText().

◆ getRestriction()

MarkpatrolledAction::getRestriction ( )

Definition at line 41 of file MarkpatrolledAction.php.

◆ onSubmit()

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

Definition at line 95 of file MarkpatrolledAction.php.

References Action\getOutput(), getRecentChange(), SpecialPage\getTitleFor(), Action\getUser(), Action\msg(), and RC_NEW.

◆ onSuccess()

MarkpatrolledAction::onSuccess ( )

Definition at line 136 of file MarkpatrolledAction.php.

◆ preText()

MarkpatrolledAction::preText ( )

Definition at line 62 of file MarkpatrolledAction.php.

References $title, getRecentChange(), Action\msg(), and Message\rawParam().

◆ usesOOUI()

MarkpatrolledAction::usesOOUI ( )

Definition at line 45 of file MarkpatrolledAction.php.

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