ProtectAction Class Reference

Handle page protection (action=protect) More...

Inherits FormlessAction.

Inherited by UnprotectAction.

Collaboration diagram for ProtectAction:

Public Member Functions
	doesWrites ()
	Indicates whether POST requests handled by this action require write access to the wiki.
	getName ()
	Return the name of the action this object responds to.
	onView ()
	Show something on GET request.
	show ()
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.
	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 ()
	Indicates whether this action page write access to the wiki.
	setHookContainer (HookContainer $hookContainer)

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 Member Functions inherited from Action
	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 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

Handle page protection (action=protect)

This is a wrapper that will call Article::protect().

Definition at line 28 of file ProtectAction.php.

Member Function Documentation

doesWrites()

ProtectAction::doesWrites

(

)

Indicates whether POST requests handled by this action require write access to the wiki.

Subclasses must override this method to return true if any of the operations that they perform on POST requests are not "safe" per RFC 7231 section 4.2.1. A subclass's operation is "safe" if it is essentially read-only, i.e. the client does not request nor expect any state change that would be observable in the responses to future requests.

Implementations of this method must always return the same value, regardless of the parameters passed to the constructor or system state.

When handling GET/HEAD requests, subclasses should only perform "safe" operations. Note that some subclasses might only perform "safe" operations even for POST requests, particularly in the case where large input parameters are required.

Returns

bool

Since

1.27

Stability: stable

to override

Reimplemented from Action.

Reimplemented in UnprotectAction.

Definition at line 42 of file ProtectAction.php.

getName()

ProtectAction::getName

(

)

Return the name of the action this object responds to.

Since

1.17

Returns

string Lowercase name

Reimplemented from Action.

Reimplemented in UnprotectAction.

Definition at line 30 of file ProtectAction.php.

onView()

ProtectAction::onView

(

)

Show something on GET request.

Returns

string|null Will be added to the HTMLForm if present, or just added to the output if not. Return null to not add anything

Reimplemented from FormlessAction.

Definition at line 34 of file ProtectAction.php.

show()

ProtectAction::show

(

)

Stability: stable

to override

Reimplemented from FormlessAction.

Reimplemented in UnprotectAction.

Definition at line 38 of file ProtectAction.php.

References Action\getArticle().

---

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

• includes/actions/ProtectAction.php