Handles the page protection UI and backend. More...

Public Member Functions
	__construct (Page $article)
	buildCleanupScript ()
	buildForm ()
	Build the input form.
	buildSelector ($action, $selected)
	Build protection level selector.
	execute ()
	Main entry point for action=protect and action=unprotect.
	getExpiry ($action)
	Get the expiry time for a given action, by combining the relevant inputs.
	loadData ()
	Loads the current state of protection into the object.
	save ()
	Save submitted protection form.
	show ($err=null)
	Show the input form with optional error message.
	showLogExtract (&$out)
	Show protection long extracts for this page.
Public Attributes
	$mApplicableTypes = array()
	Types (i.e.
	$mCascade = false
	True if the restrictions are cascading, from request or existing protection.
	$mExistingExpiry = array()
	Map of action to the expiry time of the existing protection.
	$mExpiry = array()
	Map of action to "other" expiry time.
	$mExpirySelection = array()
	Map of action to value selected in expiry drop-down list.
	$mPermErrors = array()
	Permissions errors for the protect action.
	$mReason = ''
	The custom/additional protection reason.
	$mReasonSelection = ''
	The reason selected from the list, blank for other/additional.
	$mRestrictions = array()
	A map of action to restriction level, from request or default.
Private Member Functions
	getOptionLabel ($permission)
	Prepare the label for a protection selector option.

Detailed Description

Handles the page protection UI and backend.

Definition at line 29 of file ProtectionForm.php.

Constructor & Destructor Documentation

ProtectionForm::__construct ( Page $ article )

Definition at line 60 of file ProtectionForm.php.

References $wgUser, loadData(), wfReadOnly(), and wfReadOnlyReason().

Member Function Documentation

ProtectionForm::buildCleanupScript ( )

Definition at line 602 of file ProtectionForm.php.

References $options, $wgOut, Xml\encodeJsCall(), Html\inlineScript(), ResourceLoader\makeLoaderConditionalScript(), and wfMessage().

Referenced by buildForm().

ProtectionForm::buildForm ( )

Build the input form.

Returns:: String: HTML form

Definition at line 336 of file ProtectionForm.php.

References $out, $t, $title, $value, $wgLang, $wgOut, $wgUser, buildCleanupScript(), buildSelector(), Xml\checkLabel(), Xml\closeElement(), Xml\element(), Html\hidden(), Xml\input(), Xml\label(), Linker\link(), Xml\listDropDown(), Title\makeTitle(), Xml\openElement(), Xml\option(), Xml\submitButton(), Xml\tags(), wfMessage(), and wfRunHooks().

Referenced by show().

ProtectionForm::buildSelector	(	$	action,
		$	selected
	)

Build protection level selector.

Parameters:

$action	String: action to protect
$selected	String: current protection level

Returns:: String: HTML fragment

Definition at line 551 of file ProtectionForm.php.

References $out, $wgUser, Xml\closeElement(), getOptionLabel(), Xml\openElement(), and Xml\option().

Referenced by buildForm().

ProtectionForm::execute ( )

Main entry point for action=protect and action=unprotect.

Definition at line 184 of file ProtectionForm.php.

References $wgOut, save(), and show().

ProtectionForm::getExpiry ( $ action )

Get the expiry time for a given action, by combining the relevant inputs.

Parameters:

$action string

Returns:: string 14-char timestamp or "infinity", or false if the input was invalid

Definition at line 157 of file ProtectionForm.php.

References $value, wfGetDB(), and wfTimestamp().

Referenced by save().

ProtectionForm::getOptionLabel ( $ permission ) [private]

Prepare the label for a protection selector option.

Parameters:

$permission String: permission required

Returns:: String

Definition at line 590 of file ProtectionForm.php.

References wfMessage().

Referenced by buildSelector().

ProtectionForm::loadData ( )

Loads the current state of protection into the object.

Definition at line 84 of file ProtectionForm.php.

References $wgUser.

Referenced by __construct().

ProtectionForm::save ( )

Save submitted protection form.

Returns:: Boolean: success

Definition at line 249 of file ProtectionForm.php.

References $wgOut, $wgUser, WatchAction\doUnwatch(), WatchAction\doWatch(), getExpiry(), show(), wfMessage(), wfRunHooks(), and wfTimestampNow().

Referenced by execute().

ProtectionForm::show ( $ err = null )

Show the input form with optional error message.

Parameters:

$err	String: error message or null if there's no error

Definition at line 206 of file ProtectionForm.php.

References $title, $wgOut, buildForm(), showLogExtract(), wfEscapeWikiText(), and wfMessage().

Referenced by execute(), and save().

ProtectionForm::showLogExtract ( &$ out )

Show protection long extracts for this page.

Parameters:

$out	OutputPage private

Definition at line 631 of file ProtectionForm.php.

References $out, Xml\element(), and wfRunHooks().

Referenced by show().

Member Data Documentation

ProtectionForm::$mApplicableTypes = array()

Types (i.e.

actions) for which levels can be selected

Definition at line 55 of file ProtectionForm.php.

ProtectionForm::$mCascade = false

True if the restrictions are cascading, from request or existing protection.

Definition at line 40 of file ProtectionForm.php.

ProtectionForm::$mExistingExpiry = array()

Map of action to the expiry time of the existing protection.

Definition at line 58 of file ProtectionForm.php.

ProtectionForm::$mExpiry = array()

Map of action to "other" expiry time.

Used in preference to mExpirySelection.

Definition at line 43 of file ProtectionForm.php.

ProtectionForm::$mExpirySelection = array()

Map of action to value selected in expiry drop-down list.

Will be set to 'othertime' whenever mExpiry is set.

Definition at line 49 of file ProtectionForm.php.

ProtectionForm::$mPermErrors = array()

Permissions errors for the protect action.

Definition at line 52 of file ProtectionForm.php.

ProtectionForm::$mReason = ''

The custom/additional protection reason.

Definition at line 34 of file ProtectionForm.php.

ProtectionForm::$mReasonSelection = ''

The reason selected from the list, blank for other/additional.

Definition at line 37 of file ProtectionForm.php.

ProtectionForm::$mRestrictions = array()

A map of action to restriction level, from request or default.

Definition at line 31 of file ProtectionForm.php.

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

includes/ProtectionForm.php

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation