MediaWiki  REL1_22
SpecialUnblock Class Reference

A special page for unblocking users. More...

Inheritance diagram for SpecialUnblock:
Collaboration diagram for SpecialUnblock:

List of all members.

Public Member Functions

 __construct ()
 execute ($par)
 Default execute method Checks user permissions, calls the function given in mFunction.

Static Public Member Functions

static processUIUnblock (array $data, HTMLForm $form)
 Submit callback for an HTMLForm object.
static processUnblock (array $data, IContextSource $context)
 Process the form.

Protected Member Functions

 getFields ()
 getGroupName ()
 Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

Protected Attributes

 $block
 $target
 $type

Detailed Description

A special page for unblocking users.

Definition at line 29 of file SpecialUnblock.php.


Constructor & Destructor Documentation

Definition at line 35 of file SpecialUnblock.php.


Member Function Documentation

SpecialUnblock::execute ( subPage)

Default execute method Checks user permissions, calls the function given in mFunction.

This must be overridden by subclasses; it will be made abstract in a future version

Parameters:
$subPagestring|null

Reimplemented from SpecialPage.

Definition at line 39 of file SpecialUnblock.php.

References $form, $out, array(), block, SpecialPage\checkPermissions(), SpecialPage\checkReadOnly(), SpecialPage\getContext(), getFields(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialBlock\getTargetAndType(), list, SpecialPage\msg(), Block\newFromTarget(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), type, Block\TYPE_AUTO, Block\TYPE_ID, Block\TYPE_IP, Block\TYPE_RANGE, Block\TYPE_USER, and wfEscapeWikiText().

Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

Returns:
string
Since:
1.21

Reimplemented from SpecialPage.

Definition at line 219 of file SpecialUnblock.php.

static SpecialUnblock::processUIUnblock ( array data,
HTMLForm form 
) [static]

Submit callback for an HTMLForm object.

Parameters:
array$data
HTMLForm$form
Returns:
Array( Array(message key, parameters)

Definition at line 145 of file SpecialUnblock.php.

References ContextSource\getContext(), and processUnblock().

static SpecialUnblock::processUnblock ( array data,
IContextSource context 
) [static]

Process the form.

Parameters:
$dataArray
$contextIContextSource
Exceptions:
ErrorPageError
Returns:
Array( Array(message key, parameters) ) on failure, True on success

Definition at line 157 of file SpecialUnblock.php.

References $block, $target, $type, array(), SpecialBlock\checkUnblockSelf(), SpecialBlock\getTargetAndType(), IContextSource\getUser(), User\idFromName(), list, Title\makeTitle(), Block\newFromTarget(), Block\TYPE_AUTO, Block\TYPE_IP, Block\TYPE_RANGE, and RevisionDeleteUser\unsuppressUserName().

Referenced by ApiUnblock\execute(), and processUIUnblock().


Member Data Documentation

SpecialUnblock::$block [protected]

Definition at line 33 of file SpecialUnblock.php.

Referenced by processUnblock().

SpecialUnblock::$target [protected]

Definition at line 31 of file SpecialUnblock.php.

Referenced by getFields(), and processUnblock().

SpecialUnblock::$type [protected]

Definition at line 32 of file SpecialUnblock.php.

Referenced by getFields(), and processUnblock().


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