ProtectAction Class Reference

Handle page protection. More...

Inheritance diagram for ProtectAction:

Collaboration diagram for ProtectAction:

Public Member Functions
	doesWrites ()
	Indicates whether this action may perform database writes.
	getName ()
	Return the name of the action this object responds to.
	onView ()
	Show something on GET request.
	show ()
	The main action entry point.
Public Member Functions inherited from Action
	__construct (Page $page, IContextSource $context=null)
	Only public since 1.21.
	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 ( $key)
	Get a Message object with context set Parameters are the same as wfMessage()
	requiresUnblock ()
	Whether this action can still be executed by a blocked user.
	requiresWrite ()
	Whether this action requires the wiki not to be locked.

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.
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 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\> tag.
	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
	$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.

Detailed Description

Handle page protection.

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

Definition at line 33 of file ProtectAction.php.

Member Function Documentation

doesWrites()

ProtectAction::doesWrites

(

)

Indicates whether this action may perform database writes.

Returns

bool

Since

1.27

Reimplemented from Action.

Reimplemented in UnprotectAction.

Definition at line 55 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 35 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 39 of file ProtectAction.php.

show()

ProtectAction::show

(

)

The main action entry point.

Do all output for display and send it to the context output. Do not use globals $wgOut, $wgRequest, etc, in implementations; use $this->getOutput(), etc.

Since

1.17

Exceptions

ErrorPageError

Reimplemented from FormlessAction.

Reimplemented in UnprotectAction.

Definition at line 43 of file ProtectAction.php.

References $out, Action\getContext(), and Action\getOutput().

---

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

• includes/actions/ProtectAction.php