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

Collaboration diagram for MediaWiki\Actions\MarkpatrolledAction:

[legend]

Public Member Functions
	__construct (Article $article, IContextSource $context, LinkRenderer $linkRenderer, PatrolManager $patrolManager, RecentChangeLookup $recentChangeLookup)

	doesWrites ()
	Stability: stable to override Returns bool

	getName ()
	Return the name of the action this object responds to. Since 1.17 Returns string Lowercase name

	getRestriction ()
	Get the permission required to perform this action.Often, but not always, the same as the action nameImplementations 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

	onSubmit ( $data)

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

Public Member Functions inherited from MediaWiki\Actions\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 MediaWiki\Actions\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 ()
	Indicates whether this action page write access to the wiki.

	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. Since 1.17 Stability: stable to override Returns string HTML

	getRecentChange ( $data=null)

	preText ()
	Add pre- or post-text to the form. Stability: stable to override Returns string HTML which will be sent to $form->addPreHtml()

	usesOOUI ()
	Whether the form should use OOUI. Stability: stable to override Returns bool

Protected Member Functions inherited from MediaWiki\Actions\FormAction
	getForm ()
	Get the HTMLForm to control behavior.

	getFormFields ()
	Get an HTMLForm descriptor array.

	postText ()

Protected Member Functions inherited from MediaWiki\Actions\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 MediaWiki\Actions\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 MediaWiki\Actions\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 30 of file MarkpatrolledAction.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Actions\MarkpatrolledAction::__construct	(	Article	$article,
		IContextSource	$context,
		LinkRenderer	$linkRenderer,
		PatrolManager	$patrolManager,
		RecentChangeLookup	$recentChangeLookup )

Parameters

Article	$article
IContextSource	$context
LinkRenderer	$linkRenderer
PatrolManager	$patrolManager
RecentChangeLookup	$recentChangeLookup

Definition at line 43 of file MarkpatrolledAction.php.

References MediaWiki\Actions\Action\$context.

Member Function Documentation

◆ alterForm()

MediaWiki\Actions\MarkpatrolledAction::alterForm ( HTMLForm $form )

protected

Play with the HTMLForm if you need to more substantially.

Stability: stable: to override

Parameters

HTMLForm $form

Reimplemented from MediaWiki\Actions\FormAction.

Definition at line 118 of file MarkpatrolledAction.php.

References MediaWiki\HTMLForm\HTMLForm\addHiddenField(), MediaWiki\Actions\Action\getRequest(), MediaWiki\HTMLForm\HTMLForm\setSubmitTextMsg(), and MediaWiki\HTMLForm\HTMLForm\setTokenSalt().

◆ doesWrites()

MediaWiki\Actions\MarkpatrolledAction::doesWrites ( )

Stability: stable: to override

Returns: bool

Reimplemented from MediaWiki\Actions\FormAction.

Definition at line 174 of file MarkpatrolledAction.php.

◆ getDescription()

MediaWiki\Actions\MarkpatrolledAction::getDescription ( )

protected

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

Since: 1.17

Stability: stable: to override

Returns: string HTML

Reimplemented from MediaWiki\Actions\Action.

Definition at line 63 of file MarkpatrolledAction.php.

◆ getName()

MediaWiki\Actions\MarkpatrolledAction::getName ( )

Return the name of the action this object responds to.

Since: 1.17

Returns: string Lowercase name

Reimplemented from MediaWiki\Actions\Action.

Definition at line 58 of file MarkpatrolledAction.php.

◆ getRecentChange()

MediaWiki\Actions\MarkpatrolledAction::getRecentChange ( $data = null )

protected

Parameters

array | null $data

Returns: RecentChange

Definition at line 82 of file MarkpatrolledAction.php.

References MediaWiki\Actions\Action\getRequest().

Referenced by MediaWiki\Actions\MarkpatrolledAction\onSubmit(), and MediaWiki\Actions\MarkpatrolledAction\preText().

◆ getRestriction()

MediaWiki\Actions\MarkpatrolledAction::getRestriction ( )

Get the permission required to perform this action.Often, but not always, the same as the action nameImplementations 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 MediaWiki\Actions\Action.

Definition at line 69 of file MarkpatrolledAction.php.

◆ onSubmit()

MediaWiki\Actions\MarkpatrolledAction::onSubmit ( $data )

Parameters

array $data

Returns: bool|StatusValue True for success, false for didn't-try, StatusValue on failure

Reimplemented from MediaWiki\Actions\FormAction.

Definition at line 128 of file MarkpatrolledAction.php.

References MediaWiki\Actions\Action\getAuthority(), MediaWiki\Actions\Action\getOutput(), MediaWiki\Actions\MarkpatrolledAction\getRecentChange(), MediaWiki\SpecialPage\SpecialPage\getTitleFor(), and MediaWiki\Actions\Action\msg().

◆ onSuccess()

MediaWiki\Actions\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 MediaWiki\Actions\FormAction.

Definition at line 169 of file MarkpatrolledAction.php.

◆ preText()

MediaWiki\Actions\MarkpatrolledAction::preText ( )

protected

Add pre- or post-text to the form.

Stability: stable: to override

Returns: string HTML which will be sent to $form->addPreHtml()

Reimplemented from MediaWiki\Actions\FormAction.

Definition at line 96 of file MarkpatrolledAction.php.

References MediaWiki\Actions\MarkpatrolledAction\getRecentChange(), MediaWiki\Actions\Action\msg(), and MediaWiki\Message\Message\rawParam().

◆ usesOOUI()

MediaWiki\Actions\MarkpatrolledAction::usesOOUI ( )

protected

Whether the form should use OOUI.

Stability: stable: to override

Returns: bool

Reimplemented from MediaWiki\Actions\FormAction.

Definition at line 74 of file MarkpatrolledAction.php.

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

includes/Actions/MarkpatrolledAction.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ alterForm()

◆ doesWrites()

◆ getDescription()

◆ getName()

◆ getRecentChange()

◆ getRestriction()

◆ onSubmit()

◆ onSuccess()

◆ preText()

◆ usesOOUI()