MediaWiki  master
ProtectionForm Class Reference

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

Collaboration diagram for ProtectionForm:

Public Member Functions

 __construct (Article $article)
 
 buildForm ()
 Build the input form. More...
 
 buildSelector ( $action, $selected)
 Build protection level selector. More...
 
 execute ()
 Main entry point for action=protect and action=unprotect. More...
 
 getExpiry ( $action)
 Get the expiry time for a given action, by combining the relevant inputs. More...
 
 loadData ()
 Loads the current state of protection into the object. More...
 
 save ()
 Save submitted protection form. More...
 
 show ( $err=null)
 Show the input form with optional error message. More...
 

Protected Attributes

array $mApplicableTypes = []
 Types (i.e. More...
 
bool $mCascade = false
 True if the restrictions are cascading, from request or existing protection. More...
 
array $mExistingExpiry = []
 Map of action to the expiry time of the existing protection. More...
 
array $mExpiry = []
 Map of action to "other" expiry time. More...
 
array $mExpirySelection = []
 Map of action to value selected in expiry drop-down list. More...
 
array $mPermErrors = []
 Permissions errors for the protect action. More...
 
string $mReason = ''
 The custom/additional protection reason. More...
 
string $mReasonSelection = ''
 The reason selected from the list, blank for other/additional. More...
 
array $mRestrictions = []
 A map of action to restriction level, from request or default. More...
 

Private Member Functions

 getOptionLabel ( $permission)
 Prepare the label for a protection selector option. More...
 
 showLogExtract (OutputPage $out)
 Show protection long extracts for this page. More...
 

Private Attributes

IContextSource $mContext
 

Detailed Description

Handles the page protection UI and backend.

Definition at line 30 of file ProtectionForm.php.

Constructor & Destructor Documentation

◆ __construct()

ProtectionForm::__construct ( Article  $article)

Member Function Documentation

◆ buildForm()

◆ buildSelector()

ProtectionForm::buildSelector (   $action,
  $selected 
)

Build protection level selector.

Parameters
string$actionAction to protect
string$selectedCurrent protection level
Returns
string HTML fragment

Definition at line 585 of file ProtectionForm.php.

References as, getOptionLabel(), and null.

Referenced by buildForm().

◆ execute()

ProtectionForm::execute ( )

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

Definition at line 181 of file ProtectionForm.php.

References save(), and show().

◆ getExpiry()

ProtectionForm::getExpiry (   $action)

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

Parameters
string$action
Returns
string|false 14-char timestamp or "infinity", or false if the input was invalid

Definition at line 154 of file ProtectionForm.php.

References $time, $value, wfIsInfinity(), and wfTimestamp().

Referenced by save().

◆ getOptionLabel()

ProtectionForm::getOptionLabel (   $permission)
private

Prepare the label for a protection selector option.

Parameters
string$permissionPermission required
Returns
string

Definition at line 614 of file ProtectionForm.php.

Referenced by buildSelector().

◆ loadData()

ProtectionForm::loadData ( )

Loads the current state of protection into the object.

Definition at line 92 of file ProtectionForm.php.

References $request, and as.

Referenced by __construct().

◆ save()

ProtectionForm::save ( )

Save submitted protection form.

Returns
bool Success

Definition at line 273 of file ProtectionForm.php.

References $mReason, $mReasonSelection, $out, $request, $user, as, WatchAction\doWatchOrUnwatch(), getExpiry(), Hooks\run(), show(), and wfTimestampNow().

Referenced by execute().

◆ show()

ProtectionForm::show (   $err = null)

Show the input form with optional error message.

Parameters
string|string[]|null$err Error message or null if there's no error

Definition at line 205 of file ProtectionForm.php.

References $out, $title, $titles, as, buildForm(), list, showLogExtract(), and wfEscapeWikiText().

Referenced by execute(), and save().

◆ showLogExtract()

ProtectionForm::showLogExtract ( OutputPage  $out)
private

Show protection long extracts for this page.

Parameters
OutputPage$out

Definition at line 632 of file ProtectionForm.php.

References OutputPage\addHTML(), Xml\element(), null, Hooks\run(), and LogEventsList\showLogExtract().

Referenced by show().

Member Data Documentation

◆ $mApplicableTypes

array ProtectionForm::$mApplicableTypes = []
protected

Types (i.e.

actions) for which levels can be selected

Definition at line 56 of file ProtectionForm.php.

◆ $mCascade

bool ProtectionForm::$mCascade = false
protected

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

Definition at line 41 of file ProtectionForm.php.

Referenced by buildForm().

◆ $mContext

IContextSource ProtectionForm::$mContext
private

Definition at line 62 of file ProtectionForm.php.

Referenced by buildForm().

◆ $mExistingExpiry

array ProtectionForm::$mExistingExpiry = []
protected

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

Definition at line 59 of file ProtectionForm.php.

◆ $mExpiry

array ProtectionForm::$mExpiry = []
protected

Map of action to "other" expiry time.

Used in preference to mExpirySelection.

Definition at line 44 of file ProtectionForm.php.

◆ $mExpirySelection

array ProtectionForm::$mExpirySelection = []
protected

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

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

Definition at line 50 of file ProtectionForm.php.

◆ $mPermErrors

array ProtectionForm::$mPermErrors = []
protected

Permissions errors for the protect action.

Definition at line 53 of file ProtectionForm.php.

◆ $mReason

string ProtectionForm::$mReason = ''
protected

The custom/additional protection reason.

Definition at line 35 of file ProtectionForm.php.

Referenced by save().

◆ $mReasonSelection

string ProtectionForm::$mReasonSelection = ''
protected

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

Definition at line 38 of file ProtectionForm.php.

Referenced by save().

◆ $mRestrictions

array ProtectionForm::$mRestrictions = []
protected

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

Definition at line 32 of file ProtectionForm.php.


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